1/// \page runtime Navigating the C Runtime Documentation 2/// 3/// If you are familiar with Doxygen generated documentation, then the layout of the files, typedefs 4/// and so on will be familiar to you. However there is also additional structure applied that helps 5/// the programmer to see how the runtime is made up. 6/// 7/// \section modules Modules 8/// 9/// Under the Modules menu tree you will find the entry API Classes. This section is further 10/// divided into typedefs and structs and the standard runtime supplied interface implementation 11/// methods. 12/// 13/// The typedefs are the types that you declare in your code and which are returned by the 14/// 'constructors' such as antlr38BitFileStreamNew(). The underlying structures document 15/// the data elements of the type and what a function pointer installed in any particular 16/// slot should do. 17/// 18/// The default implementations are the static methods within the default implementation file 19/// for a 'class', which are installed by the runtime when a default instance of one the 20/// typedefs (classes) is created. 21/// 22/// When navigating the source code, find the typedef you want to consult and inspect the documentation 23/// for its function pointers, then look at the documentation for the default methods that implement 24/// that 'method'. 25/// 26/// For example, under "API Typedefs and Structs" you will find "Base Recognizer Definition", which tells 27/// you all the methods that belong to this interface. Under "API Implementation Functions", you will 28/// find "Base Recognizer Implementation", which documents the actual functions that are installed 29/// to implement the class methods. 30/// 31/// From here, the documentation should be obvious. If it is not, then you could try reading 32/// the actual source code, but please don't email the author directly, use the ANTLR Interest 33/// email group, which you should probably have signed up for if you have read this far into the 34/// C runtime documentation. 35///