From bf0d37bf28412d3ed1ddd4460e3d32e66aa01b17 Mon Sep 17 00:00:00 2001 From: Yorik van Havre Date: Thu, 17 Nov 2016 17:04:09 -0200 Subject: [PATCH] Doc: Fixes in doxygen docs for Draft,Arch, FEM --- src/App/PropertyContainer.cpp | 1 + src/App/core-app.dox | 11 ++- src/Base/MemDebug.cpp | 1 + src/Doc/BuildWebDoc.cfg.in | 4 +- src/Doc/CMakeLists.txt | 3 + src/Doc/mainpage.dox | 2 +- src/Doc/primary-groups.dox | 3 +- src/Doc/templates/doxy-boot.js | 91 ++++++++++++++++++- src/Doc/templates/header.html | 4 +- src/Gui/Command.cpp | 1 + src/Gui/core-gui.dox | 6 +- src/Main/core-main.dox | 4 +- src/Mod/Arch/Arch.py | 7 +- src/Mod/Arch/ArchAxis.py | 9 ++ src/Mod/Arch/ArchBuilding.py | 9 ++ src/Mod/Arch/ArchCommands.py | 9 ++ src/Mod/Arch/ArchComponent.py | 8 ++ src/Mod/Arch/ArchCutPlane.py | 8 ++ src/Mod/Arch/ArchEquipment.py | 10 ++ src/Mod/Arch/ArchFloor.py | 10 ++ src/Mod/Arch/ArchFrame.py | 10 ++ src/Mod/Arch/ArchMaterial.py | 8 +- src/Mod/Arch/ArchPanel.py | 11 +++ src/Mod/Arch/ArchPipe.py | 9 ++ src/Mod/Arch/ArchPrecast.py | 10 +- src/Mod/Arch/ArchProfile.py | 9 ++ src/Mod/Arch/ArchRebar.py | 10 ++ src/Mod/Arch/ArchRoof.py | 10 ++ src/Mod/Arch/ArchSchedule.py | 10 ++ src/Mod/Arch/ArchSectionPlane.py | 11 ++- src/Mod/Arch/ArchServer.py | 9 ++ src/Mod/Arch/ArchSite.py | 10 ++ src/Mod/Arch/ArchSpace.py | 10 ++ src/Mod/Arch/ArchStairs.py | 9 +- src/Mod/Arch/ArchStructure.py | 11 +++ src/Mod/Arch/ArchVRM.py | 9 ++ src/Mod/Arch/ArchWall.py | 11 +++ src/Mod/Arch/ArchWindow.py | 11 +++ src/Mod/Arch/arch.dox | 2 +- src/Mod/Arch/import3DS.py | 5 + src/Mod/Arch/importDAE.py | 8 ++ src/Mod/Arch/importGBXML.py | 9 +- src/Mod/Arch/importIFC.py | 6 ++ src/Mod/Arch/importOBJ.py | 10 ++ src/Mod/Arch/importSH3D.py | 6 ++ src/Mod/Arch/importWebGL.py | 9 ++ src/Mod/Draft/Draft.py | 3 + src/Mod/Draft/DraftGeomUtils.py | 4 + src/Mod/Draft/DraftGui.py | 7 +- src/Mod/Draft/DraftSnap.py | 6 ++ src/Mod/Draft/DraftTools.py | 6 +- src/Mod/Draft/DraftTrackers.py | 5 +- src/Mod/Draft/DraftVecUtils.py | 5 + src/Mod/Draft/WorkingPlane.py | 7 ++ src/Mod/Draft/draft.dox | 4 +- src/Mod/Draft/importAirfoilDAT.py | 6 ++ src/Mod/Draft/importDWG.py | 8 ++ src/Mod/Draft/importDXF.py | 6 ++ src/Mod/Draft/importOCA.py | 8 ++ src/Mod/Draft/importSVG.py | 8 ++ src/Mod/Drawing/drawing.dox | 4 +- src/Mod/Fem/FemAnalysis.py | 4 + src/Mod/Fem/FemBeamSection.py | 4 + src/Mod/Fem/FemCommands.py | 4 + src/Mod/Fem/FemConstraintSelfWeight.py | 4 + src/Mod/Fem/FemInputWriter.py | 4 + src/Mod/Fem/FemInputWriterCcx.py | 4 + src/Mod/Fem/FemInputWriterZ88.py | 4 + src/Mod/Fem/FemMaterialMechanicalNonlinear.py | 4 + src/Mod/Fem/FemMeshTools.py | 4 + src/Mod/Fem/FemSelectionObserver.py | 4 + src/Mod/Fem/FemShellThickness.py | 4 + src/Mod/Fem/FemSolverCalculix.py | 4 + src/Mod/Fem/FemSolverZ88.py | 4 + src/Mod/Fem/FemTools.py | 4 + src/Mod/Fem/FemToolsCcx.py | 4 + src/Mod/Fem/FemToolsZ88.py | 4 + src/Mod/Fem/MechanicalMaterial.py | 4 + src/Mod/Fem/_CommandAnalysis.py | 3 + src/Mod/Fem/_CommandBeamSection.py | 2 + src/Mod/Fem/_CommandConstraintSelfWeight.py | 2 + src/Mod/Fem/_CommandControlSolver.py | 3 + .../_CommandMaterialMechanicalNonlinear.py | 2 + src/Mod/Fem/_CommandMechanicalMaterial.py | 2 + src/Mod/Fem/_CommandMeshFromShape.py | 3 + src/Mod/Fem/_CommandPurgeResults.py | 3 + src/Mod/Fem/_CommandRunSolver.py | 3 + src/Mod/Fem/_CommandShellThickness.py | 2 + src/Mod/Fem/_CommandShowResult.py | 3 + src/Mod/Fem/_CommandSolverCalculix.py | 2 + src/Mod/Fem/_CommandSolverZ88.py | 2 + src/Mod/Fem/_FemBeamSection.py | 2 + src/Mod/Fem/_FemConstraintSelfWeight.py | 2 + .../Fem/_FemMaterialMechanicalNonlinear.py | 2 + src/Mod/Fem/_FemShellThickness.py | 2 + src/Mod/Fem/_FemSolverCalculix.py | 2 + src/Mod/Fem/_FemSolverZ88.py | 2 + src/Mod/Fem/_MechanicalMaterial.py | 2 + src/Mod/Fem/_TaskPanelFemBeamSection.py | 2 + src/Mod/Fem/_TaskPanelFemShellThickness.py | 2 + src/Mod/Fem/_TaskPanelFemSolverCalculix.py | 3 + src/Mod/Fem/_TaskPanelMechanicalMaterial.py | 2 + src/Mod/Fem/_TaskPanelShowResult.py | 2 + src/Mod/Fem/_ViewProviderFemBeamSection.py | 2 + .../_ViewProviderFemConstraintSelfWeight.py | 2 + ...wProviderFemMaterialMechanicalNonlinear.py | 2 + src/Mod/Fem/_ViewProviderFemShellThickness.py | 2 + src/Mod/Fem/_ViewProviderFemSolverCalculix.py | 2 + src/Mod/Fem/_ViewProviderFemSolverZ88.py | 2 + .../Fem/_ViewProviderMechanicalMaterial.py | 2 + src/Mod/Fem/ccxDatReader.py | 2 + src/Mod/Fem/ccxFrdReader.py | 3 + src/Mod/Fem/convert2TetGen.py | 5 + src/Mod/Fem/fem.dox | 4 +- src/Mod/Fem/importInpMesh.py | 2 + src/Mod/Fem/importZ88Mesh.py | 2 + src/Mod/Fem/z88DispReader.py | 2 + src/Mod/Idf/idf.dox | 2 + src/Mod/Image/image.dox | 4 +- src/Mod/Import/import.dox | 2 +- src/Mod/Inspection/Inspection.dox | 2 +- src/Mod/Material/material.dox | 4 + src/Mod/Measure/measure.dox | 2 + src/Mod/Mesh/mesh.dox | 4 +- src/Mod/MeshPart/meshpart.dox | 4 +- src/Mod/OpenSCAD/OpenSCAD.dox | 6 +- src/Mod/Part/part.dox | 4 +- src/Mod/PartDesign/partdesign.dox | 4 +- src/Mod/Path/path.dox | 4 + src/Mod/Plot/plot.dox | 4 +- src/Mod/Points/points.dox | 4 +- src/Mod/Raytracing/raytracing.dox | 4 +- .../ReverseEngineering/reverseengineering.dox | 4 +- src/Mod/Robot/robot.dox | 4 +- src/Mod/Sandbox/sandbox.dox | 2 +- src/Mod/Ship/ship.dox | 4 +- src/Mod/Show/show.dox | 0 src/Mod/Sketcher/sketcher.dox | 4 +- src/Mod/Spreadsheet/spreadsheet.dox | 4 +- src/Mod/Start/start.dox | 4 +- src/Mod/TechDraw/techdraw.dox | 4 + src/Mod/Test/test.dox | 4 +- src/Mod/Web/web.dox | 4 +- src/Mod/mod.dox | 29 +++++- 144 files changed, 743 insertions(+), 58 deletions(-) create mode 100644 src/Mod/Idf/idf.dox create mode 100644 src/Mod/Material/material.dox create mode 100644 src/Mod/Measure/measure.dox create mode 100644 src/Mod/Path/path.dox create mode 100644 src/Mod/Show/show.dox create mode 100644 src/Mod/TechDraw/techdraw.dox diff --git a/src/App/PropertyContainer.cpp b/src/App/PropertyContainer.cpp index e8a2a2d844..fc154f3b5a 100644 --- a/src/App/PropertyContainer.cpp +++ b/src/App/PropertyContainer.cpp @@ -475,6 +475,7 @@ void PropertyData::getPropertyList(OffsetBase offsetBase,std::vector /** \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#. diff --git a/src/App/core-app.dox b/src/App/core-app.dox index 37edc722c8..a50a1ceb0d 100644 --- a/src/App/core-app.dox +++ b/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...... */ diff --git a/src/Base/MemDebug.cpp b/src/Base/MemDebug.cpp index 20fa8dc05c..ceecf0f940 100644 --- a/src/Base/MemDebug.cpp +++ b/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 diff --git a/src/Doc/BuildWebDoc.cfg.in b/src/Doc/BuildWebDoc.cfg.in index 0afb606c72..938e55626c 100644 --- a/src/Doc/BuildWebDoc.cfg.in +++ b/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. diff --git a/src/Doc/CMakeLists.txt b/src/Doc/CMakeLists.txt index da6aea96b7..311a449f2f 100644 --- a/src/Doc/CMakeLists.txt +++ b/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}") diff --git a/src/Doc/mainpage.dox b/src/Doc/mainpage.dox index ba707605ca..971b3e396f 100644 --- a/src/Doc/mainpage.dox +++ b/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 Wiki Documentation instead. + first to the Wiki Documentation. Refer to the general diff --git a/src/Doc/primary-groups.dox b/src/Doc/primary-groups.dox index cfaa9f2789..4eaa0206f8 100644 --- a/src/Doc/primary-groups.dox +++ b/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 diff --git a/src/Doc/templates/doxy-boot.js b/src/Doc/templates/doxy-boot.js index fe199ca93b..3c5f490edd 100644 --- a/src/Doc/templates/doxy-boot.js +++ b/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 - + $projectname: $title $title @@ -45,7 +45,7 @@
  • API Home
  • Modules
    • -
  • Namespaces and Classes
    • +
  • Class list
  • Source code