Doc: small adjustments to doxygen docs

FreeCAD · Nov 15, 2016 · 48c118c · 48c118c
1 parent 725f9ad
commit 48c118c
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 27 deletions.
diff --git a/src/Base/core-base.dox b/src/Base/core-base.dox
@@ -1,28 +1,23 @@
-/** \defgroup BASE Base classes
- * \ingroup CORE */
+/** \defgroup BASE Base
+ *  \ingroup CORE
+    \brief Basic structures used by other FreeCAD components
+
+    The Base module includes most of the basic functions of FreeCAD, such as:
+    - Console services: printing different kinds of messages to the FreeCAD report view or the terminal
+    - Python interpreter: handles the execution of Python code in FreeCAD
+    - Parameter handling: Management, saving and restoring of user preferences settings
+    - Units: Management and conversion of different units
 
-/*! \namespace Base
-    \brief The namespace of the FreeCAD Base library
-
-    This namespace includes most of the basic functions of FreeCAD like
-	- Console srvices
-	- Interpreter (Python binding)
-	- Parameter handling
-
-  and so on......
 */
 
-/** \defgroup BASE Base classes
- * \ingroup CORE */
-
 /*! \namespace Base
-    \brief The namespace of the FreeCAD Base library
-
-    This namespace includes most of the basic functions of FreeCAD like
-	- Console srvices
-	- Interpreter (Python binding)
-	- Parameter handling
-
-  and so on......
+    \ingroup BASE
+    \brief Basic structures used by other FreeCAD components
+
+    The Base module includes most of the basic functions of FreeCAD, such as:
+    - Console services: printing different kinds of messages to the FreeCAD report view or the terminal
+    - Python interpreter: handles the execution of Python code in FreeCAD
+    - Parameter handling: Management, saving and restoring of user preferences settings
+    - Units: Management and conversion of different units
 */
 
diff --git a/src/Doc/CMakeLists.txt b/src/Doc/CMakeLists.txt
@@ -43,6 +43,7 @@ if(DOXYGEN_FOUND)
     set(        DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Tools)
     list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/3rdParty/CxImage)
     list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/3rdParty/salomesmesh)
+    list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Mod/Assembly)
 
     STRING(REGEX REPLACE ";" " " DOXYGEN_EXCLUDE_LIST "${DOXYGEN_EXCLUDE_DIR}")
 

diff --git a/src/Doc/primary-groups.dox b/src/Doc/primary-groups.dox
@@ -8,6 +8,6 @@
 /** \defgroup WORKBENCHES Workbenches
  */
 
-/** \defgroup EMBEDDED Embedded 3rd party material
+/** \defgroup EMBEDDED Embedded 3rd party libraries
     Important tools and libraries incorporated to FreeCAD.
  */
diff --git a/src/Doc/templates/customdoxygen.css b/src/Doc/templates/customdoxygen.css
@@ -336,9 +336,9 @@ span.SRScope {
 
 }
 
-.memItemLeft, .memTemplItemLeft {
+/*.memItemLeft, .memTemplItemLeft {
   white-space: normal;
-}
+} */
 
 /* enumerations */
 .panel-body thead > tr {

diff --git a/src/Doc/templates/header.html b/src/Doc/templates/header.html
@@ -26,6 +26,7 @@
         <link rel="stylesheet" href="http://www.freecadweb.org/css/freecad.css">
         <script src="http://www.freecadweb.org/js/bootstrap-3.3.5.min.js"></script>
         <script type="text/javascript" src="$relpath^doxy-boot.js"></script>
+        <link rel="shortcut icon" href="http://www.freecadweb.org/images/favicon.ico">
     </head>
     <body>        
         <div class="navbar navbar-inverse navbar-fixed-top" role="navigation">
@@ -42,9 +43,10 @@
                 <div class="collapse navbar-collapse">
                     <ul class="nav navbar-nav">
                         <li><a href="/api/index.html" title="Welcome page">API Home</a></li>
-                        <li><a href="modules.html" title="List of FreeCAD Modules">Index</a></li>
+                        <li><a href="modules.html" title="List of FreeCAD Modules">Modules</a></li>
                         <!-- <li><a href="namespaces.html" title="Namespaces">Namespaces</a></li> -->
-                        <li><a href="annotated.html" title="List of namespaces and classes">Classes list</a></li>
+                        <li><a href="annotated.html" title="List of namespaces and classes">Namespaces and Classes</a></li>
+                        <li><a href="https://github.com/FreeCAD/FreeCAD" title="Browse the source code on GitHub">Source code</a></li>
                     </ul>
                     <ul class="nav navbar-nav navbar-right">
                         <form class="navbar-search navbar-form" action="http://duckduckgo.com/" id="searchform" role="search" method="get">