diff --git a/Doc/ApiDocIntro.dox b/Doc/ApiDocIntro.dox index 572f6c010..dfd24185a 100644 --- a/Doc/ApiDocIntro.dox +++ b/Doc/ApiDocIntro.dox @@ -7,8 +7,6 @@ * extracted and shaped into an easy to browse hypermedia documentation. Links * to related information make getting along much easier. * - * \section This documentation's features - * * In the top of the page you can find the project and version this documentation * was created for. In the menu bar below you see three entries. * @@ -22,7 +20,24 @@ * sections that can be expanded. Here you find inheritance and collaboration * diagrams that can help navigate around quickly. * - * \section Enriching the code + * \section structure Oolite Code Structure + * + * There are two entry points: + * + * + * These two may process the command line arguments. But watch out, other classes or functions may do so, too. Check for uses of + * NSProcessInfo, as it happens e.g. in src/SDL/MyOpenGLView.m or src/Core/Entities/PlayerEntity.m. + * + * \section maintenance Maintaining this documentation + * + * \subsection comments Enriching the code * * As mentioned above, this documentation contains all the information from * the source code. Of course you can enrich the source with more information @@ -30,10 +45,12 @@ * favourite editing tool. Just add comments in a way that doxygen can * recognize - and this is a small change only. * + * This entry page can be found under Doc/ApiDocIntro.dox. + * * See more at * Documenting the code * - * \subsection Generating this documentation + * \subsection processing Generating this documentation * * To generate the most up to date documentation, just invoke Doxygen from the * project's main directory. All the necessary settings are in the Doxyfile diff --git a/src/Cocoa/main.m b/src/Cocoa/main.m index 63699f9dd..3a295d119 100644 --- a/src/Cocoa/main.m +++ b/src/Cocoa/main.m @@ -7,7 +7,12 @@ NSUInteger gDebugFlags = 0; #endif - +/** + * Entry point for MacOS. + * + * @param argc the number of command line arguments + * @param argv the string array values of the command line arguments + */ int main(int argc, const char *argv[]) { OOLoggingInit(); diff --git a/src/SDL/main.m b/src/SDL/main.m index 380464a02..ce3815065 100644 --- a/src/SDL/main.m +++ b/src/SDL/main.m @@ -49,7 +49,13 @@ uint32_t gDebugFlags = 0; #endif - +/** + * Entry point for Linux and Windows systems. + * If -load is passed, the argument after that is loaded as savegame. + * + * @param argc the number of command line arguments + * @param argv the string array values of the command line arguments + */ int main(int argc, char *argv[]) { #ifdef GNUSTEP