Skip to content

Commit f9e3dcc

Browse files
authored
Update Docs (#354)
* Sort members. Update project title. * Show all sections by default. Rename API category -> API Reference * Update URLs in readme. * Ignore docs folder for CI builds.
1 parent 9c749ff commit f9e3dcc

File tree

4 files changed

+11
-9
lines changed

4 files changed

+11
-9
lines changed

.github/workflows/ci.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,14 @@ on:
77
- development
88
paths-ignore:
99
- '**.md'
10+
- 'docs/**'
1011
pull_request:
1112
branches:
1213
- master
1314
- development
1415
paths-ignore:
1516
- '**.md'
17+
- 'docs/**'
1618
workflow_dispatch:
1719
inputs:
1820
tag:

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,6 @@ Checking in the console or server logs, you should get the following output:
122122
## Core Services
123123
Anvil is bundled with a core set of services that you can depend on in your own plugins and systems.
124124

125-
These services handle game events, task scheduling, and more! Examples of how to use these services can be found in the [Anvil docs](https://nwn-dotnet.github.io/Anvil/classNWN_1_1Services_1_1ServiceBindingAttribute.html#details).
125+
These services handle game events, task scheduling, and more! Examples of how to use these services can be found in the [Anvil docs](https://nwn-dotnet.github.io/Anvil/classAnvil_1_1Services_1_1ServiceBindingAttribute.html).
126126

127-
You can also find a full list of the services bundled by Anvil [HERE](https://nwn-dotnet.github.io/Anvil/namespaceNWN_1_1Services.html).
127+
You can also find a full list of the services bundled by Anvil [HERE](https://nwn-dotnet.github.io/Anvil/namespaceAnvil_1_1Services.html).

docs/Doxyfile

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# Project related configuration options
55
#---------------------------------------------------------------------------
66
DOXYFILE_ENCODING = UTF-8
7-
PROJECT_NAME = "NWN.Managed"
7+
PROJECT_NAME = "Anvil"
88
PROJECT_NUMBER =
99
PROJECT_BRIEF =
1010
PROJECT_LOGO =
@@ -82,10 +82,10 @@ SHOW_GROUPED_MEMB_INC = NO
8282
FORCE_LOCAL_INCLUDES = NO
8383
INLINE_INFO = YES
8484
SORT_MEMBER_DOCS = YES
85-
SORT_BRIEF_DOCS = NO
86-
SORT_MEMBERS_CTORS_1ST = NO
85+
SORT_BRIEF_DOCS = YES
86+
SORT_MEMBERS_CTORS_1ST = YES
8787
SORT_GROUP_NAMES = YES
88-
SORT_BY_SCOPE_NAME = NO
88+
SORT_BY_SCOPE_NAME = YES
8989
STRICT_PROTO_MATCHING = NO
9090
GENERATE_TODOLIST = YES
9191
GENERATE_TESTLIST = YES
@@ -209,7 +209,7 @@ HTML_COLORSTYLE_SAT = 100
209209
HTML_COLORSTYLE_GAMMA = 80
210210
HTML_TIMESTAMP = NO
211211
HTML_DYNAMIC_SECTIONS = YES
212-
HTML_INDEX_NUM_ENTRIES = 100
212+
HTML_INDEX_NUM_ENTRIES = 0
213213
GENERATE_DOCSET = NO
214214
DOCSET_FEEDNAME = "Doxygen generated docs"
215215
DOCSET_BUNDLE_ID = org.doxygen.Project
@@ -221,7 +221,7 @@ HHC_LOCATION =
221221
GENERATE_CHI = NO
222222
CHM_INDEX_ENCODING =
223223
BINARY_TOC = NO
224-
TOC_EXPAND = NO
224+
TOC_EXPAND = YES
225225
GENERATE_QHP = NO
226226
QCH_FILE =
227227
QHP_NAMESPACE = org.doxygen.Project

docs/DoxygenLayout.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<!-- Navigation index tabs for HTML output -->
44
<navindex>
55
<tab type="mainpage" visible="yes" title=""/>
6-
<tab type="classlist" visible="yes" title="API" intro=""/>
6+
<tab type="classlist" visible="yes" title="API Reference" intro=""/>
77
</navindex>
88

99
<!-- Layout definition for a class page -->

0 commit comments

Comments
 (0)