fix namespace type references + update contributing.md

5 files changed, 28 insertions, 14 deletions

diff --git a/Doxyfile b/Doxyfile
index f2714cd..07c86d1 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -17,11 +17,10 @@ GENERATE_LATEX = NO
 LAYOUT_FILE = src/doc/layout.xml
 TAB_SIZE = 2
 
-HTML_INDEX_NUM_ENTRIES = 2
+HTML_INDEX_NUM_ENTRIES = 999
 HTML_EXTRA_STYLESHEET = src/doc/style.css
 SHOW_HEADERFILE = NO
 
-USE_MDFILE_AS_MAINPAGE = ./readme.md
 REPEAT_BRIEF = NO
 
 EXTRACT_STATIC = YES
@@ -29,6 +28,7 @@ HIDE_UNDOC_NAMESPACES = YES
 HIDE_UNDOC_CLASSES = YES
 
 QUIET = YES
+WARNINGS = NO
 
 # set these to NO for user-only docs
 INTERNAL_DOCS = YES
diff --git a/contributing.md b/contributing.md
index 9f22c60..7dedaa7 100644
--- a/contributing.md
+++ b/contributing.md
@@ -983,18 +983,25 @@ following format:
 - A **minimal** example to demonstrate how the feature is used. The example
   should be written such that the following is clear to the reader:
   - Which headers need to be included to utilize the feature
+  - *Why* the example works, not what is happening in the example
   - Where is this code supposed to be called (e.g. inside scene/script
     functions)
-  - *Why* the example works, not what is happening in the example
   - Which restrictions should be kept in mind (e.g. copy/move semantics, max
     component instances, speed considerations)
 
 Features should be documented as clear and concise as possible, so the following
 points should be kept in mind:
 
-- If a page expands on an example from another page, directly reference the
-  other page using a cross-reference (`\ref`) instead of writing a larger
-  example
+- <details><summary>
+  If a page expands on an example from another page, directly reference the
+  other page using a cross-reference (`\ref`) in a `\note` block at the top of
+  the page.
+  </summary>
+
+  ```
+  \note This page builds on top of the example shown in \ref feature_script
+  ```
+  </details>
 - When explaining the usage of specific functions, qualify them such that
   Doxygen is able to add a cross-reference or manually add a reference using the
   `\ref` command.
diff --git a/src/doc/index.dox b/src/doc/index.dox
index 5ec7889..7796f34 100644
--- a/src/doc/index.dox
+++ b/src/doc/index.dox
@@ -8,3 +8,10 @@ Welcome to the documentation for the crêpe game engine.
 \see feature
 
 */
+
+/**
+
+\namespace crepe
+\brief Engine namespace
+
+*/
diff --git a/src/doc/layout.xml b/src/doc/layout.xml
index fb4cc0c..6336655 100644
--- a/src/doc/layout.xml
+++ b/src/doc/layout.xml
@@ -11,7 +11,7 @@
 			<tab type="modulelist" visible="yes" title="" intro=""/>
 			<tab type="modulemembers" visible="yes" title="" intro=""/>
 		</tab>
-		<tab type="namespaces" visible="no" title="">
+		<tab type="namespaces" visible="yes" title="">
 			<tab type="namespacelist" visible="yes" title="" intro=""/>
 			<tab type="namespacemembers" visible="yes" title="" intro=""/>
 		</tab>
@@ -56,10 +56,10 @@
 			<interfaces title=""/>
 			<publicslots title=""/>
 			<signals title=""/>
-			<publicmethods title=""/>
-			<publicstaticmethods title=""/>
 			<publicattributes title=""/>
 			<publicstaticattributes title=""/>
+			<publicmethods title=""/>
+			<publicstaticmethods title=""/>
 			<protectedtypes title=""/>
 			<protectedslots title=""/>
 			<protectedmethods title=""/>
@@ -102,11 +102,12 @@
 	</class>
 	<namespace>
 		<briefdescription visible="yes"/>
+		<detaileddescription title=""/>
 		<memberdecl>
 			<nestednamespaces visible="yes" title=""/>
 			<constantgroups visible="yes" title=""/>
 			<interfaces visible="yes" title=""/>
-			<classes visible="yes" title=""/>
+			<classes visible="no" title=""/>
 			<concepts visible="yes" title=""/>
 			<structs visible="yes" title=""/>
 			<exceptions visible="yes" title=""/>
@@ -119,7 +120,6 @@
 			<properties title=""/>
 			<membergroups visible="yes"/>
 		</memberdecl>
-		<detaileddescription title=""/>
 		<memberdef>
 			<inlineclasses title=""/>
 			<typedefs title=""/>
diff --git a/src/doc/style.css b/src/doc/style.css
index daabd39..c12240c 100644
--- a/src/doc/style.css
+++ b/src/doc/style.css
@@ -1,6 +1,6 @@
 #titlearea,
-address {
-	display: none;
-}
+address,
+a[href="namespaces.html"]
+{ display: none; }
 
 h2.groupheader { margin-top: revert; }