Doc: Fixes in doxygen docs for Draft,Arch, FEM

src/App/PropertyContainer.cpp

@@ -475,6 +475,7 @@ void PropertyData::getPropertyList(OffsetBase offsetBase,std::vector<Property*>
 
 /** \defgroup PropFrame Property framework
     \ingroup APP
+    \brief System to access object properties
 \section Introduction
 The property framework introduces the ability to access attributes (member variables) of a class by name without
 knowing the class type. It's like the reflection mechanism of Java or C#.

src/App/core-app.dox

@@ -1,15 +1,16 @@
 /** \defgroup APP App side
- * \ingroup CORE */
+ * \ingroup CORE 
+ * \brief The part of FreeCAD that works without GUI (console or server mode)
+*/
 
 /** \namespace App
     \ingroup APP
-    \brief The namespace of the FreeCAD Aplication layer library.
+    \brief The FreeCAD Aplication layer
 
     This namespace includes Aplication services of FreeCAD like:
-	- The Application class 
-	- The Document class
+    - The Application class 
+    - The Document class
 
 
-  and so on......
 */
 

src/Base/MemDebug.cpp

@@ -24,6 +24,7 @@
 
 /** \defgroup MemDebug Memory debugging
  *  \ingroup BASE
+ *  \brief Memory debugging tools
  * \section Overview
  * In C++ applications there are a lot of ways to handle memory allocation and deallocation.
  * As many ways to do it wrong or simply forget to free memory. One way to overcome

src/Doc/BuildWebDoc.cfg.in

@@ -493,7 +493,7 @@ SHOW_DIRECTORIES       = YES
 # This will remove the Files entry from the Quick Index and from the
 # Folder Tree View (if specified). The default is YES.
 
-SHOW_FILES             = YES
+SHOW_FILES             = NO
 
 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
 # Namespaces page.
@@ -962,7 +962,7 @@ TOC_EXPAND             = NO
 # that can be used as input for Qt's qhelpgenerator to generate a
 # Qt Compressed Help (.qch) of the generated HTML documentation.
 
-GENERATE_QHP           = YES
+GENERATE_QHP           = NO
 
 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
 # be used to specify the file name of the resulting .qch file.

src/Doc/CMakeLists.txt

@@ -43,7 +43,10 @@ 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)
+    # deprecated modules
     list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Mod/Assembly)
+    list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Mod/Cam)
+    list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Mod/Complete)
 
     STRING(REGEX REPLACE ";" " " DOXYGEN_EXCLUDE_LIST "${DOXYGEN_EXCLUDE_DIR}")
 

src/Doc/mainpage.dox

@@ -31,7 +31,7 @@
     components of the FreeCAD source code, for both the parts written in C++ and Python. 
 
     For general help and documentation about the FreeCAD application and how to use it, head
-    to the <a href=http//www.freecadweb.org/wiki>Wiki Documentation</a> instead.
+    first to the <a href=http//www.freecadweb.org/wiki>Wiki Documentation</a>.
 
     Refer to the
     <a href=http://www.freecadweb.org/wiki/index.php?title=The_FreeCAD_source_code>general 

src/Doc/primary-groups.dox

@@ -2,7 +2,8 @@
     This is the core functionality of FreeCAD.
 
     It groups the Base classes, and the main components of freecad core,
-    spread over their App and Gui sides
+    spread over their App and Gui sides. Core components are programmed in
+    C++ but provide a broad Python API.
  */
 
 /** \defgroup WORKBENCHES Workbenches

src/Doc/templates/doxy-boot.js

@@ -155,7 +155,6 @@ $( document ).ready(function() {
     return document.getElementById("search-close");
   }
 
-
   /* search results */
   var results_iframe = $('#MSearchResults').detach();
   $('#MSearchResultsWindow')
@@ -269,3 +268,93 @@ $( document ).ready(function() {
 	});
   searchBox.CloseResultsWindow();
 });
+
+// contents of dynsections.js which seems to be missing from std doxygen js files...
+function toggleVisibility(linkObj)
+{
+ var base = $(linkObj).attr('id');
+ var summary = $('#'+base+'-summary');
+ var content = $('#'+base+'-content');
+ var trigger = $('#'+base+'-trigger');
+ var src=$(trigger).attr('src');
+ if (content.is(':visible')===true) {
+   content.hide();
+   summary.show();
+   $(linkObj).addClass('closed').removeClass('opened');
+   $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
+ } else {
+   content.show();
+   summary.hide();
+   $(linkObj).removeClass('closed').addClass('opened');
+   $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
+ } 
+ return false;
+}
+function updateStripes()
+{
+  $('table.directory tr').
+       removeClass('even').filter(':visible:even').addClass('even');
+}
+function toggleLevel(level)
+{
+  $('table.directory tr').each(function(){ 
+    var l = this.id.split('_').length-1;
+    var i = $('#img'+this.id.substring(3));
+    var a = $('#arr'+this.id.substring(3));
+    if (l<level+1) {
+      i.attr('src','ftv2folderopen.png');
+      a.attr('src','ftv2mnode.png');
+      $(this).show();
+    } else if (l==level+1) {
+      i.attr('src','ftv2folderclosed.png');
+      a.attr('src','ftv2pnode.png');
+      $(this).show();
+    } else {
+      $(this).hide();
+    }
+  });
+  updateStripes();
+}
+function toggleFolder(id)
+{
+  //The clicked row
+  var currentRow = $('#row_'+id);
+  var currentRowImages = currentRow.find("img");
+  //All rows after the clicked row
+  var rows = currentRow.nextAll("tr");
+  //Only match elements AFTER this one (can't hide elements before)
+  var childRows = rows.filter(function() {
+    var re = new RegExp('^row_'+id+'\\d+_$', "i"); //only one sub
+    return this.id.match(re);
+  });
+  //First row is visible we are HIDING
+  if (childRows.filter(':first').is(':visible')===true) {
+    currentRowImages.filter("[id^=arr]").attr('src', 'ftv2pnode.png');
+    currentRowImages.filter("[id^=img]").attr('src', 'ftv2folderclosed.png');
+    rows.filter("[id^=row_"+id+"]").hide();
+  } else { //We are SHOWING
+    //All sub images
+    var childImages = childRows.find("img");
+    var childImg = childImages.filter("[id^=img]");
+    var childArr = childImages.filter("[id^=arr]");
+    currentRow.find("[id^=arr]").attr('src', 'ftv2mnode.png'); //open row
+    currentRow.find("[id^=img]").attr('src', 'ftv2folderopen.png'); //open row
+    childImg.attr('src','ftv2folderclosed.png'); //children closed
+    childArr.attr('src','ftv2pnode.png'); //children closed
+    childRows.show(); //show all children
+  }
+  updateStripes();
+}
+function toggleInherit(id)
+{
+  var rows = $('tr.inherit.'+id);
+  var img = $('tr.inherit_header.'+id+' img');
+  var src = $(img).attr('src');
+  if (rows.filter(':first').is(':visible')===true) {
+    rows.css('display','none');
+    $(img).attr('src',src.substring(0,src.length-8)+'closed.png');
+  } else {
+    rows.css('display','table-row'); // using show() causes jump in firefox
+    $(img).attr('src',src.substring(0,src.length-10)+'open.png');
+  }
+}

src/Doc/templates/header.html

@@ -9,7 +9,7 @@
         <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
         <meta name="generator" content="Doxygen $doxygenversion"/>
 
-        <script type="text/javascript" src="https://www.freecadweb.org/js/jquery-2.1.4.min.js"></script>
+        <script type="text/javascript" src="http://www.freecadweb.org/js/jquery-2.1.4.min.js"></script>
 
         <!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
         <!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
@@ -45,7 +45,7 @@
                         <li><a href="/api/index.html" title="Welcome page">API Home</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">Namespaces and Classes</a></li>
+                        <li><a href="annotated.html" title="List of namespaces and classes">Class list</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">

src/Gui/Command.cpp

@@ -68,6 +68,7 @@ using namespace Gui::DockWnd;
 
 /** \defgroup commands Command Framework
     \ingroup GUI
+    \brief Structure for registering commands to the FreeCAD system
  * \section Overview
  * In GUI applications many commands can be invoked via a menu item, a toolbar button or an accelerator key. The answer of Qt to master this
  * challenge is the class \a QAction. A QAction object can be added to a popup menu or a toolbar and keep the state of the menu item and

src/Gui/core-gui.dox

@@ -1,8 +1,10 @@
 /** \defgroup GUI Gui side
- * \ingroup CORE */
+ * \ingroup CORE 
+ * \brief The Graphical User Interface of FreeCAD and the 3D View
+ */
 
 /** \namespace Gui
-    \brief The namespace of the FreeCAD Graphical interface layer library.
+    \brief The FreeCAD Graphical interface layer
 
     This namespace includes the grafical interface of FreeCAD like:
 	- The main window

src/Main/core-main.dox

@@ -1,2 +1,4 @@
 /** \defgroup MAIN Global application level 
- * \ingroup CORE */
+ * \ingroup CORE 
+ * \brief The Main classes define general application settings
+ */

src/Mod/Arch/Arch.py

@@ -26,11 +26,12 @@
 __url__ = "http://www.freecadweb.org"
 
 ## \defgroup ARCH Arch
-#  \ingroup WORKBENCHES
-#
-#  Architecture and BIM module
+#  \ingroup PYTHONWORKBENCHES
+#  \brief Architecture and BIM tools
 #
 #  This module provides tools specialized in Building Information Modeling (BIM).
+#  such as convenience tools to build walls, windows or structures, and 
+#  IFC import/export capabilities.
 
 '''The Arch module provides tools specialized in BIM modeling.'''
 

src/Mod/Arch/ArchAxis.py

@@ -30,15 +30,24 @@
     from pivy import coin
     from PySide.QtCore import QT_TRANSLATE_NOOP
 else:
+    # \cond
     def translate(ctxt,txt):
         return txt
     def QT_TRANSLATE_NOOP(ctxt,txt):
         return txt
+    # \endcond
 
 __title__="FreeCAD Axis System"
 __author__ = "Yorik van Havre"
 __url__ = "http://www.freecadweb.org"
 
+## @package ArchAxis
+#  \ingroup ARCH
+#  \brief Axis system for the Arch workbench
+#
+#  This module provides tools to build axis systems
+#  An axis system is a collection of planar axes with a number/tag
+
 def makeAxis(num=5,size=1000,name="Axes"):
     '''makeAxis(num,size): makes an Axis System
     based on the given number of axes and interval distances'''

src/Mod/Arch/ArchBuilding.py

@@ -30,15 +30,24 @@
     from DraftTools import translate
     from PySide.QtCore import QT_TRANSLATE_NOOP
 else:
+    # \cond
     def translate(ctxt,txt):
         return txt
     def QT_TRANSLATE_NOOP(ctxt,txt):
         return txt
+    # \endcond
 
 __title__="FreeCAD Building"
 __author__ = "Yorik van Havre"
 __url__ = "http://www.freecadweb.org"
 
+## @package ArchBuilding
+#  \ingroup ARCH
+#  \brief Building object and tools
+#
+#  This module provides tools to build building objects.
+#  Buildings are primarily containers for Arch objects
+
 BuildingTypes = ['Undefined',
 'Agricultural - Barn',
 'Agricultural - Chicken coop or chickenhouse',

src/Mod/Arch/ArchCommands.py

@@ -30,13 +30,22 @@
     from PySide import QtGui,QtCore
     from DraftTools import translate
 else:
+    # \cond
     def translate(ctxt,txt):
         return txt
+    # \endcond
 
 __title__="FreeCAD Arch Commands"
 __author__ = "Yorik van Havre"
 __url__ = "http://www.freecadweb.org"
 
+## @package ArchCommands
+#  \ingroup ARCH
+#  \brief Utility functions for theArch Workbench
+#
+#  This module provides general functions used by Arch tools
+#  and utility commands
+
 # module functions ###############################################
 
 def getStringList(objects):

src/Mod/Arch/ArchComponent.py

@@ -39,11 +39,19 @@
     from DraftTools import translate
     from PySide.QtCore import QT_TRANSLATE_NOOP
 else:
+    # \cond
     def translate(ctxt,txt):
         return txt
     def QT_TRANSLATE_NOOP(ctxt,txt):
         return txt
-
+    # \endcond
+
+## @package ArchComponent
+#  \ingroup ARCH
+#  \brief The base class of all Arch objects
+#
+#  This module provides the base Arch component class, that
+#  is shared by all of the Arch BIM objects
 
 def addToComponent(compobject,addobject,mod=None):
     '''addToComponent(compobject,addobject,mod): adds addobject

src/Mod/Arch/ArchCutPlane.py

@@ -28,13 +28,21 @@
     from PySide import QtCore, QtGui
     from DraftTools import translate
 else:
+    # \cond
     def translate(ctxt,txt):
         return txt
+    # \endcond
 
 __title__="FreeCAD CutPlane"
 __author__ = "Jonathan Wiedemann"
 __url__ = "http://www.freecadweb.org"
 
+## @package ArchCutPlane
+#  \ingroup ARCH
+#  \brief The Cut plane object and tools
+#
+#  This module handles the Cut Plane object
+
 def cutComponentwithPlane(archObject, cutPlane, sideFace):
     """cut object from a plan define by a face, Behind = 0 , front = 1"""
     cutVolume = ArchCommands.getCutVolume(cutPlane, archObject.Object.Shape)

src/Mod/Arch/ArchEquipment.py

@@ -35,10 +35,20 @@
     from DraftTools import translate
     from PySide.QtCore import QT_TRANSLATE_NOOP
 else:
+    # \cond
     def translate(ctxt,txt):
         return txt
     def QT_TRANSLATE_NOOP(ctxt,txt):
         return txt
+    # \endcond
+
+## @package ArchEquipment
+#  \ingroup ARCH
+#  \brief The Equipment object and tools
+#
+#  This module provides tools to build equipment objects.
+#  Equipments are used to represent furniture and all kinds of electrical
+#  or hydraulic appliances in a building
 
 # presets
 Roles = ["Furniture", "Hydro Equipment", "Electric Equipment"]