|
7 | 7 | * extracted and shaped into an easy to browse hypermedia documentation. Links
|
8 | 8 | * to related information make getting along much easier.
|
9 | 9 | *
|
10 |
| - * \section This documentation's features |
11 |
| - * |
12 | 10 | * In the top of the page you can find the project and version this documentation
|
13 | 11 | * was created for. In the menu bar below you see three entries.
|
14 | 12 | *
|
|
22 | 20 | * sections that can be expanded. Here you find inheritance and collaboration
|
23 | 21 | * diagrams that can help navigate around quickly.
|
24 | 22 | *
|
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 |
26 | 38 | *
|
27 | 39 | * As mentioned above, this documentation contains all the information from
|
28 | 40 | * the source code. Of course you can enrich the source with more information
|
29 | 41 | * easily. The huge advanatage is that you do not even need to leave your
|
30 | 42 | * favourite editing tool. Just add comments in a way that doxygen can
|
31 | 43 | * recognize - and this is a small change only.
|
32 | 44 | *
|
| 45 | + * This entry page can be found under Doc/ApiDocIntro.dox. |
| 46 | + * |
33 | 47 | * See more at
|
34 | 48 | * <a href="https://www.doxygen.nl/manual/docblocks.html">Documenting the code</a>
|
35 | 49 | *
|
36 |
| - * \subsection Generating this documentation |
| 50 | + * \subsection processing Generating this documentation |
37 | 51 | *
|
38 | 52 | * To generate the most up to date documentation, just invoke Doxygen from the
|
39 | 53 | * project's main directory. All the necessary settings are in the Doxyfile
|
|
0 commit comments