Skip to content

Commit 4d65277

Browse files
author
hiran
committed
improved documentation entry page. What is the application's entry point?
1 parent 0d8009a commit 4d65277

File tree

3 files changed

+31
-6
lines changed

3 files changed

+31
-6
lines changed

Doc/ApiDocIntro.dox

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@
77
* extracted and shaped into an easy to browse hypermedia documentation. Links
88
* to related information make getting along much easier.
99
*
10-
* \section This documentation's features
11-
*
1210
* In the top of the page you can find the project and version this documentation
1311
* was created for. In the menu bar below you see three entries.
1412
*
@@ -22,18 +20,34 @@
2220
* sections that can be expanded. Here you find inheritance and collaboration
2321
* diagrams that can help navigate around quickly.
2422
*
25-
* \section Enriching the code
23+
* \section structure Oolite Code Structure
24+
*
25+
* There are two entry points:
26+
* <ul>
27+
* <li><a href="https://github.com/OoliteProject/oolite/blob/master/src/Cocoa/main.m#L11">int main(int argc, const char *argv[])</a><br/>
28+
* for MacOS
29+
* </li>
30+
* <li><a href="https://github.com/OoliteProject/oolite/blob/master/src/SDL/main.m#L53">int main(int argc, char *argv[])</a><br/>
31+
* for Linux and Windows
32+
* </li>
33+
* </ul>
34+
*
35+
* \section maintenance Maintaining this documentation
36+
*
37+
* \subsection comments Enriching the code
2638
*
2739
* As mentioned above, this documentation contains all the information from
2840
* the source code. Of course you can enrich the source with more information
2941
* easily. The huge advanatage is that you do not even need to leave your
3042
* favourite editing tool. Just add comments in a way that doxygen can
3143
* recognize - and this is a small change only.
3244
*
45+
* This entry page can be found under Doc/ApiDocIntro.dox.
46+
*
3347
* See more at
3448
* <a href="https://www.doxygen.nl/manual/docblocks.html">Documenting the code</a>
3549
*
36-
* \subsection Generating this documentation
50+
* \subsection processing Generating this documentation
3751
*
3852
* To generate the most up to date documentation, just invoke Doxygen from the
3953
* project's main directory. All the necessary settings are in the Doxyfile

src/Cocoa/main.m

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@
77
NSUInteger gDebugFlags = 0;
88
#endif
99

10-
10+
/**
11+
* Entry point for MacOS.
12+
*
13+
* @param argc the number of command line arguments
14+
* @param argv the string array values of the command line arguments
15+
*/
1116
int main(int argc, const char *argv[])
1217
{
1318
OOLoggingInit();

src/SDL/main.m

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,13 @@
4949
uint32_t gDebugFlags = 0;
5050
#endif
5151

52-
52+
/**
53+
* Entry point for Linux and Windows systems.
54+
* If -load is passed, the argument after that is loaded as savegame.
55+
*
56+
* @param argc the number of command line arguments
57+
* @param argv the string array values of the command line arguments
58+
*/
5359
int main(int argc, char *argv[])
5460
{
5561
#ifdef GNUSTEP

0 commit comments

Comments
 (0)