Documentation|Doxygen: Redesigned stylesheets for API documentation

The Doxygen CSS stylesheets were modified to follow Doomsday's visual style. Also cleaned up some details of the code documentation, and excluded all private implementation related information from the generated pages. IssueID #2127
skyjake · Nov 20, 2015 · ede6d10 · ede6d10
1 parent e8e35fd
commit ede6d10
Show file tree

Hide file tree

Showing 32 changed files with 1,152 additions and 9,475 deletions.
diff --git a/doomsday/apps/client/api.doxy b/doomsday/apps/client/api.doxy
@@ -4,6 +4,8 @@
 PROJECT_NAME            = "Doomsday and liblegacy"
 PROJECT_NUMBER          = 2.0
 PROJECT_BRIEF           = "Public API"
+PROJECT_LOGO            = ../../doc/apidoc-logo.png
+HTML_STYLESHEET         = ../../doxygen.css
 OUTPUT_DIRECTORY        = ../../apidoc/api/
 
 INPUT                   = ../api
@@ -17,3 +19,5 @@ REFERENCED_BY_RELATION  = NO
 OPTIMIZE_OUTPUT_FOR_C   = NO
 MACRO_EXPANSION         = YES
 EXPAND_ONLY_PREDEF      = YES
+EXTRACT_PRIVATE         = NO
+INTERNAL_DOCS           = NO
diff --git a/doomsday/apps/client/client-mac.doxy b/doomsday/apps/client/client-mac.doxy
@@ -4,6 +4,8 @@
 PROJECT_NAME        = "Doomsday Client"
 PROJECT_NUMBER      = 2.0
 PROJECT_BRIEF       = "Internal documentation (Mac OS X)"
+PROJECT_LOGO        = ../../doc/apidoc-logo.png
+HTML_STYLESHEET     = ../../doxygen.css
 OUTPUT_DIRECTORY    = ../../apidoc/mac/
 
 INPUT               = ../api include src
@@ -13,4 +15,10 @@ MACRO_EXPANSION     = YES
 PREDEFINED          = __DOOMSDAY__ __CLIENT__ UNIX MACOSX __cplusplus "C_DECL=" "GL_CALL=" \
                       "DENG2_PIMPL(ClassName)=typedef ClassName Public; struct ClassName::Instance : public de::Private<ClassName>" \
                       "DENG2_PIMPL_NOREF(C)=struct C::Instance : public de::IPrivate" \
-                      "DENG2_PRIVATE(Var)=struct Instance; Instance *Var;"
+                      "DENG_GUI_PIMPL(C)=struct C::public de::GuiWidgetPrivate<C>" \
+                      "DENG2_PRIVATE(Var)=struct Instance; Instance *Var;" \
+                      "DENG2_ERROR(N)=class N : public de::Error {};" \
+                      "DENG2_SUB_ERROR(B,N)=class N : public B {};" \
+                      "DENG2_OBSERVES(C,A)=public C::I##Audience##Observer"
+
+EXTRACT_PRIVATE     = NO
diff --git a/doomsday/apps/client/client-win32.doxy b/doomsday/apps/client/client-win32.doxy
@@ -4,12 +4,21 @@
 PROJECT_NAME        = "Doomsday Client"
 PROJECT_NUMBER      = 2.0
 PROJECT_BRIEF       = "Internal documentation (Windows)"
+PROJECT_LOGO        = ../../doc/apidoc-logo.png
+HTML_STYLESHEET     = ../../doxygen.css
 OUTPUT_DIRECTORY    = ../../apidoc/win32/
 
 INPUT               = ../api include src
 EXCLUDE             = include/unix include/macx src/unix src/macx
 
+MACRO_EXPANSION     = YES
 PREDEFINED          = __DOOMSDAY__ __CLIENT__ WIN32 __cplusplus \
-                      "DENG2_PIMPL(C)=typedef C Public; struct C::Instance : public de::Private<C>" \
+                      "DENG2_PIMPL(ClassName)=typedef ClassName Public; struct ClassName::Instance : public de::Private<ClassName>" \
                       "DENG2_PIMPL_NOREF(C)=struct C::Instance : public de::IPrivate" \
-                      "DENG2_PRIVATE(Var)=struct Instance; Instance *Var;"
+                      "DENG_GUI_PIMPL(C)=struct C::public de::GuiWidgetPrivate<C>" \
+                      "DENG2_PRIVATE(Var)=struct Instance; Instance *Var;" \
+                      "DENG2_ERROR(N)=class N : public de::Error {};" \
+                      "DENG2_SUB_ERROR(B,N)=class N : public B {};" \
+                      "DENG2_OBSERVES(C,A)=public C::I##Audience##Observer"
+
+EXTRACT_PRIVATE     = NO