Skip to content

Commit 3788e46

Browse files
committed
Improved CSharp documentation
1 parent 74d27d8 commit 3788e46

File tree

15 files changed

+3027
-861
lines changed

15 files changed

+3027
-861
lines changed

luacs-docs/cs/Doxyfile

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ DOXYFILE_ENCODING = UTF-8
4747
# title of most generated pages and in a few other places.
4848
# The default value is: My Project.
4949

50-
PROJECT_NAME = "Barotrauma Doc"
50+
PROJECT_NAME = "LuaCsForBarotrauma"
5151

5252
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
5353
# could be handy for archiving the generated documentation or if some version
@@ -348,6 +348,7 @@ OPTIMIZE_OUTPUT_SLICE = NO
348348
# Note see also the list of default file extension mappings.
349349

350350
EXTENSION_MAPPING =
351+
EXTENSION_MAPPING += dox=md
351352

352353
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
353354
# according to the Markdown format, which allows for more readable
@@ -912,7 +913,7 @@ WARN_LOGFILE =
912913
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
913914
# Note: If this tag is empty the current directory is searched.
914915

915-
INPUT = .
916+
INPUT = ./
916917

917918
# This tag can be used to specify the character encoding of the source files
918919
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1110,7 +1111,7 @@ FILTER_SOURCE_PATTERNS =
11101111
# (index.html). This can be useful if you have a project on for instance GitHub
11111112
# and want to reuse the introduction page also for the doxygen output.
11121113

1113-
USE_MDFILE_AS_MAINPAGE = ./intro.md
1114+
USE_MDFILE_AS_MAINPAGE = ./manual/intro.md
11141115

11151116
#---------------------------------------------------------------------------
11161117
# Configuration options related to source browsing
@@ -1334,7 +1335,7 @@ HTML_STYLESHEET =
13341335
# list). For an example see the documentation.
13351336
# This tag requires that the tag GENERATE_HTML is set to YES.
13361337

1337-
HTML_EXTRA_STYLESHEET = custom.css
1338+
HTML_EXTRA_STYLESHEET =
13381339

13391340
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
13401341
# other source files which should be copied to the HTML output directory. Note
@@ -2742,3 +2743,9 @@ GENERATE_LEGEND = YES
27422743
# The default value is: YES.
27432744

27442745
DOT_CLEANUP = YES
2746+
2747+
2748+
2749+
HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \
2750+
doxygen-awesome-css/doxygen-awesome-sidebar-only.css
2751+
HTML_COLORSTYLE = LIGHT # required with Doxygen >= 1.9.5

luacs-docs/cs/DoxygenLayout.xml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
<doxygenlayout version="1.0">
22
<navindex>
3-
<tab type="user" url="./index.html" title="Documentation introduction"/>
4-
<tab type="user" url="../baro-server/html/index.html" title="Server class documentation"/>
5-
<tab type="user" url="../baro-client/html/index.html" title="Client class documentation"/>
63
<tab type="mainpage" visible="yes" title=""/>
4+
<tab type="usergroup" title="Development">
5+
<tab type="user" url="md_manual_2inmemorymod.html" title="In-memory CSharp Mod" />
6+
<tab type="user" url="md_manual_2assemblymod.html" title="Assembly CSharp Mod" />
7+
<tab type="user" url="md_manual_2harmony.html" title="Using Harmony" />
8+
</tab>
9+
<tab type="usergroup" title="Generated Documentation">
10+
<tab type="user" url="../baro-server/html/index.html" title="Server Documentation"/>
11+
<tab type="user" url="../baro-client/html/index.html" title="Client Documentation"/>
12+
</tab>
713
</navindex>
814
</doxygenlayout>

luacs-docs/cs/baro-client/Doxyfile

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ DOXYFILE_ENCODING = UTF-8
4141
# title of most generated pages and in a few other places.
4242
# The default value is: My Project.
4343

44-
PROJECT_NAME = "Barotrauma Client Doc"
44+
PROJECT_NAME = "Client LuaCsForBarotrauma"
4545

4646
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
4747
# could be handy for archiving the generated documentation or if some version
@@ -1329,7 +1329,7 @@ HTML_STYLESHEET =
13291329
# list). For an example see the documentation.
13301330
# This tag requires that the tag GENERATE_HTML is set to YES.
13311331

1332-
HTML_EXTRA_STYLESHEET = ../custom.css
1332+
HTML_EXTRA_STYLESHEET =
13331333

13341334
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
13351335
# other source files which should be copied to the HTML output directory. Note
@@ -2735,3 +2735,7 @@ GENERATE_LEGEND = YES
27352735
# The default value is: YES.
27362736

27372737
DOT_CLEANUP = YES
2738+
2739+
HTML_EXTRA_STYLESHEET = ../doxygen-awesome-css/doxygen-awesome.css \
2740+
../doxygen-awesome-css/doxygen-awesome-sidebar-only.css
2741+
HTML_COLORSTYLE = LIGHT # required with Doxygen >= 1.9.5

luacs-docs/cs/baro-client/DoxygenLayout.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- Generated by doxygen 1.9.4 -->
33
<!-- Navigation index tabs for HTML output -->
44
<navindex>
5-
<tab type="user" url="../../html/index.html" title="Documentation introduction"/>
5+
<tab type="user" url="/index.html" title="Documentation introduction"/>
66
<tab type="user" url="../../baro-server/html/index.html" title="Server class documentation"/>
77
<tab type="user" url="./index.html" title="Client class documentation"/>
88
<tab type="mainpage" visible="yes" title=""/>

luacs-docs/cs/baro-server/Doxyfile

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ DOXYFILE_ENCODING = UTF-8
4141
# title of most generated pages and in a few other places.
4242
# The default value is: My Project.
4343

44-
PROJECT_NAME = "Barotrauma Server Doc"
44+
PROJECT_NAME = "Server LuaCsForBarotrauma"
4545

4646
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
4747
# could be handy for archiving the generated documentation or if some version
@@ -1329,7 +1329,7 @@ HTML_STYLESHEET =
13291329
# list). For an example see the documentation.
13301330
# This tag requires that the tag GENERATE_HTML is set to YES.
13311331

1332-
HTML_EXTRA_STYLESHEET = ../custom.css
1332+
HTML_EXTRA_STYLESHEET =
13331333

13341334
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
13351335
# other source files which should be copied to the HTML output directory. Note
@@ -2735,3 +2735,7 @@ GENERATE_LEGEND = YES
27352735
# The default value is: YES.
27362736

27372737
DOT_CLEANUP = YES
2738+
2739+
HTML_EXTRA_STYLESHEET = ../doxygen-awesome-css/doxygen-awesome.css \
2740+
../doxygen-awesome-css/doxygen-awesome-sidebar-only.css
2741+
HTML_COLORSTYLE = LIGHT # required with Doxygen >= 1.9.5

luacs-docs/cs/baro-server/DoxygenLayout.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- Generated by doxygen 1.9.4 -->
33
<!-- Navigation index tabs for HTML output -->
44
<navindex>
5-
<tab type="user" url="../../html/index.html" title="Documentation introduction"/>
5+
<tab type="user" url="/index.html" title="Documentation introduction"/>
66
<tab type="user" url="./index.html" title="Server class documentation"/>
77
<tab type="user" url="../../baro-client/html/index.html" title="Client class documentation"/>
88
<tab type="mainpage" visible="yes" title=""/>

0 commit comments

Comments
 (0)