Documentation: Added libdeng mainpage; CSS tweaks

skyjake · Jan 13, 2012 · 3c6aa39 · 3c6aa39
1 parent 75db275
commit 3c6aa39
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 22 deletions.
diff --git a/doomsday/engine/api/doomsday.h b/doomsday/engine/api/doomsday.h
@@ -1,33 +1,37 @@
-/**\file doomsday.h
- *\section License
- * License: GPL
- * Online License Link: http://www.gnu.org/licenses/gpl.html
+/**
+ * @file doomsday.h
+ * Primary header file for the Doomsday Engine Public API
+ *
+ * @section License
+ * GPL: http://www.gnu.org/licenses/gpl.html
  *
- *\author Copyright © 2003-2012 Jaakko Keränen <jaakko.keranen@iki.fi>
- *\author Copyright © 2006-2012 Daniel Swanson <danij@dengine.net>
- *\author Copyright © 2007 Jamie Jones <jamie_jones_au@yahoo.com.au>
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 2 of the License, or (at your option)
+ * any later version.
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 51
+ * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor,
- * Boston, MA  02110-1301  USA
+ * @author Copyright &copy; 2003-2012 Jaakko Keränen <jaakko.keranen@iki.fi>
+ * @author Copyright &copy; 2006-2012 Daniel Swanson <danij@dengine.net>
+ * @author Copyright &copy; 2007 Jamie Jones <jamie_jones_au@yahoo.com.au>
  */
 
 /**
- * Doomsday Engine API (Routines exported from Doomsday.exe).
+ * @mainpage libdeng API
+ *
+ * This documentation covers all the functions and data that Doomsday makes
+ * available for games and other plugins.
  *
- * Games and plugins need to include this to gain access to the engine's
- * features.
+ * The documentation has been organized into modules
+ * (see <a href="modules.html">Modules</a>).
  */
 
 #ifndef LIBDENG_EXPORTS_H

diff --git a/doomsday/engine/doxygen.css b/doomsday/engine/doxygen.css
@@ -354,6 +354,10 @@ table.memberdecls {
 	color: #555;
 }
 
+td.mdescRight p {
+    margin: 0;
+}
+
 .memItemLeft, .memItemRight, .memTemplParams {
 	border-top: 1px solid #C4CFE5;
 }

diff --git a/doomsday/plugins/jdoom/doxygen.css b/doomsday/plugins/jdoom/doxygen.css
@@ -354,6 +354,10 @@ table.memberdecls {
 	color: #555;
 }
 
+td.mdescRight p {
+    margin: 0;
+}
+
 .memItemLeft, .memItemRight, .memTemplParams {
 	border-top: 1px solid #C4CFE5;
 }

diff --git a/doomsday/plugins/jheretic/doxygen.css b/doomsday/plugins/jheretic/doxygen.css
@@ -354,6 +354,10 @@ table.memberdecls {
 	color: #555;
 }
 
+td.mdescRight p {
+    margin: 0;
+}
+
 .memItemLeft, .memItemRight, .memTemplParams {
 	border-top: 1px solid #C4CFE5;
 }

diff --git a/doomsday/plugins/jhexen/doxygen.css b/doomsday/plugins/jhexen/doxygen.css
@@ -354,6 +354,10 @@ table.memberdecls {
 	color: #555;
 }
 
+td.mdescRight p {
+    margin: 0;
+}
+
 .memItemLeft, .memItemRight, .memTemplParams {
 	border-top: 1px solid #C4CFE5;
 }