kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Some fixes for doygen syntax errors and some configuration to make it run smoother under Windows

Browse Source
This commit is contained in:
hgutsche
2017-02-27 10:29:05 -05:00
committed by wmayer
parent e3ea61d165
commit 201c9d89b0
30 changed files with 103 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/App/Range.cpp
View File

@@ -197,9 +197,7 @@ int App::validColumn(const std::string &colstr)
*
* This function will throw an exception if the specified \a address is invalid.
*
* @param address Address to parse.
* @param row Reference to integer where row position is stored.
* @param col Reference to integer where col position is stored.
* @param strAddress Address to parse.
*
*/

4
src/Base/Reader.h
View File

@@ -182,8 +182,8 @@ protected:
// -----------------------------------------------------------------------
/** @name Content handler */
//@{
virtual void startDocument();
virtual void endDocument();
virtual void startDocument();
virtual void endDocument();
virtual void startElement(const XMLCh* const uri, const XMLCh* const localname, const XMLCh* const qname, const XERCES_CPP_NAMESPACE_QUALIFIER Attributes& attrs);
virtual void endElement (const XMLCh* const uri, const XMLCh *const localname, const XMLCh *const qname);
#if (XERCES_VERSION_MAJOR == 2)

29
src/Doc/BuildDevDoc.cfg.in
View File

@@ -170,7 +170,7 @@ SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
# Doxygen uses this value to replace tabs by spaces in code fragments.
TAB_SIZE = 8
TAB_SIZE = 4
# This tag can be used to specify a number of aliases that acts
# as commands in the documentation. An alias has the form "name=value".
@@ -287,7 +287,8 @@ TYPEDEF_HIDES_STRUCT = NO
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols
SYMBOL_CACHE_SIZE = 0
# SYMBOL_CACHE_SIZE = 0
LOOKUP_CACHE_SIZE = 3
#---------------------------------------------------------------------------
# Build related configuration options
@@ -487,7 +488,7 @@ SHOW_USED_FILES = YES
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation. The default is NO.
SHOW_DIRECTORIES = YES
# SHOW_DIRECTORIES = YES
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the
@@ -638,8 +639,12 @@ EXCLUDE_PATTERNS =*.moc.* \
*/swigpyrun*.* \
*/lex.*.c \
*/.svn/* \
*/CMakeFiles/* \
*_rc.py
*/CMakeFiles \
*_rc.py \
*.dir \
*.tlog \
*/Debug \
*/Release
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
@@ -859,7 +864,7 @@ HTML_TIMESTAMP = YES
# files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used.
HTML_ALIGN_MEMBERS = YES
# HTML_ALIGN_MEMBERS = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
@@ -1047,7 +1052,7 @@ GENERATE_TREEVIEW = NO
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list.
USE_INLINE_TREES = NO
# USE_INLINE_TREES = NO
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree
@@ -1273,13 +1278,13 @@ XML_OUTPUT = xml
# which can be used by a validating XML parser to check the
# syntax of the XML files.
XML_SCHEMA =
# XML_SCHEMA =
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
# syntax of the XML files.
XML_DTD =
# XML_DTD =
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
# dump the program listings (including syntax highlighting
@@ -1586,7 +1591,7 @@ DOT_NUM_THREADS = 0
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
# containing the font.
DOT_FONTNAME = FreeSans.ttf
DOT_FONTNAME =
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
# The default size is 10pt.
@@ -1681,7 +1686,7 @@ DOT_IMAGE_FORMAT = png
# The tag DOT_PATH can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
DOT_PATH =
DOT_PATH = @DOT_PATH@
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the
@@ -1697,7 +1702,7 @@ DOTFILE_DIRS =
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
DOT_GRAPH_MAX_NODES = 50
DOT_GRAPH_MAX_NODES = 130
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
# graphs generated by dot. A depth value of 3 means that only nodes reachable

10
src/Doc/CMakeLists.txt
View File

@@ -33,8 +33,7 @@ if(DOXYGEN_FOUND)
${CMAKE_SOURCE_DIR}/src/Mod
${CMAKE_BINARY_DIR}/src/Mod
${CMAKE_SOURCE_DIR}/src/Main
${CMAKE_SOURCE_DIR}/src/Doc
${CMAKE_BINARY_DIR}/src/Doc
${CMAKE_SOURCE_DIR}/src/Doc
)
STRING(REGEX REPLACE ";" " " DOXYGEN_INPUT_LIST "${DOXYGEN_SOURCE_DIR}")
@@ -45,6 +44,7 @@ if(DOXYGEN_FOUND)
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/Arch/Dice3DS)
list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Doc/sphinx)
# deprecated modules
list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Mod/Assembly)
list(APPEND DOXYGEN_EXCLUDE_DIR ${CMAKE_SOURCE_DIR}/src/Mod/Cam)
@@ -90,8 +90,10 @@ if(DOXYGEN_FOUND)
if (WIN32)
ADD_CUSTOM_TARGET(SourceDocu
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/BuildDevDoc.cfg
COMMAND ${QT_HELPCOMPILER_EXECUTABLE} "\"${CMAKE_BINARY_DIR}/doc/SourceDocu/html/index.qhp\""
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/doc/SourceDocu/html/index.qch ${CMAKE_BINARY_DIR}/doc/FreeCADSource.qch
if(QT_HELPCOMPILER_EXECUTABLE)
COMMAND ${QT_HELPCOMPILER_EXECUTABLE} ${CMAKE_BINARY_DIR}/doc/SourceDocu/html/index.qhp
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/doc/SourceDocu/html/index.qch ${CMAKE_BINARY_DIR}/doc/FreeCADSource.qch
endif(QT_HELPCOMPILER_EXECUTABLE)
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/BuildDevDoc.cfg
)

2
src/Doc/FreecadDoxygenLayout.xml
View File

@@ -17,7 +17,7 @@
<tab type="files" visible="yes" title=""/>
<tab type="globals" visible="yes" title=""/>
</tab>
<tab type="dirs" visible="yes" title=""/>
<!--tab type="dirs" visible="yes" title=""/-->
<tab type="examples" visible="yes" title=""/>
<tab type="pages" visible="yes" title=""/>
</navindex>

33
src/Gui/Quarter/Quarter.cpp
View File

@@ -121,22 +121,23 @@
\subpage examples
*/
/*!
\page examples More Examples
The examples code is included in Quarter and can be found in the
src/examples subdirectory.
\subpage directui
\subpage dynamicui
\subpage inheritui
\subpage mdi
\subpage examiner
*/
// These pages are not exitant in this copy of Quarter
// /*!
// \page examples More Examples
//
// The examples code is included in Quarter and can be found in the
// src/examples subdirectory.
//
// \subpage directui
//
// \subpage dynamicui
//
// \subpage inheritui
//
// \subpage mdi
//
// \subpage examiner
//*/
#include <cstdio>
#include <Inventor/SoDB.h>

4
src/Mod/Draft/App/AppDraftUtilsPy.cpp
View File

@@ -22,8 +22,8 @@
#include "PreCompiled.h"
#ifndef _PreComp_
# include <Python.h>
#ifndef _PreComp_
# include <Python.h>
#endif
#include <CXX/Extensions.hxx>

2
src/Mod/Draft/Draft.py
View File

@@ -6227,4 +6227,4 @@ class ViewProviderWorkingPlaneProxy:
return None
# @}
## @}

2
src/Mod/Draft/DraftGeomUtils.py
View File

@@ -2815,4 +2815,4 @@ def circleInversion(circle, circle2):
FreeCAD.Console.PrintMessage("debug: circleInversion bad parameters!\n")
return None
# @}
## @}

2
src/Mod/Draft/DraftVecUtils.py
View File

@@ -252,4 +252,4 @@ def removeDoubles(vlist):
nlist.append(vlist[-1])
return nlist
# @}
## @}

2
src/Mod/Fem/App/FemMeshObject.cpp
View File

@@ -92,4 +92,6 @@ template<> PyObject* Fem::FemMeshObjectPython::getPyObject(void) {
// explicit template instantiation
template class AppFemExport FeaturePythonT<Fem::FemMeshObject>;
/// @endcond
}

2
src/Mod/Fem/App/FemSolverObject.cpp
View File

@@ -77,7 +77,7 @@ template<> PyObject* Fem::FemSolverObjectPython::getPyObject(void) {
}
return Py::new_reference_to(PythonObject);
}
/// @endcond
// explicit template instantiation
template class AppFemExport FeaturePythonT<Fem::FemSolverObject>;

2
src/Mod/Fem/FemGmshTools.py
View File

@@ -425,4 +425,4 @@ class FemGmshTools():
del self.temp_file_geometry
del self.temp_file_mesh
# @}
## @}

2
src/Mod/Fem/FemInputWriter.py
View File

@@ -177,4 +177,4 @@ class FemInputWriter():
femobj['PressureFaces'] = [(femobj['Object'].Name + ': face load', pressure_faces)]
# print(femobj['PressureFaces'])
# @}
## @}

2
src/Mod/Fem/FemInputWriterZ88.py
View File

@@ -319,4 +319,4 @@ Entries for Cuthill-McKee Z88H Daten fuer Cuthill- McKee Programm
DYNAMIC END
'''
# @}
## @}

2
src/Mod/Fem/FemMeshTools.py
View File

@@ -1507,4 +1507,4 @@ def use_correct_fluidinout_ele_def(FluidInletoutlet_ele, fileName):
f.close()
inout_nodes_file.close()
# @}
## @}

2
src/Mod/Fem/FemSelectionObserver.py
View File

@@ -44,4 +44,4 @@ class FemSelectionObserver:
# on double click on a vertex of a solid sub is None and obj is the solid
self.parseSelectionFunction(self.added_obj)
# @}
## @}

2
src/Mod/Fem/FemTools.py
View File

@@ -577,4 +577,4 @@ class FemTools(QtCore.QRunnable, QtCore.QObject):
stats = match[result_type]
return stats
# @}
## @}

2
src/Mod/Fem/FemToolsCcx.py
View File

@@ -265,4 +265,4 @@ class FemToolsCcx(FemTools.FemTools):
if m.Eigenmode == mf['eigenmode']:
m.EigenmodeFrequency = mf['frequency']
# @}
## @}

2
src/Mod/Fem/FemToolsZ88.py
View File

@@ -202,4 +202,4 @@ class FemToolsZ88(FemTools.FemTools):
else:
raise Exception('FEM: No results found at {}!'.format(disp_result_file))
# @}
## @}

2
src/Mod/Fem/ObjectsFem.py
View File

@@ -315,4 +315,4 @@ for s in sorted(App.ActiveDocument.supportedTypes()):
print s
'''
# @}
## @}

2
src/Mod/Fem/PyGui/FemCommands.py
View File

@@ -176,4 +176,4 @@ class FemCommands(object):
apart.ViewObject.Visibility = True
acnstrmesh.ViewObject.Visibility = False # OvG: Hide meshes and show constraints and meshed part e.g. on purging results
# @}
## @}

2
src/Mod/Fem/convert2TetGen.py
View File

@@ -264,4 +264,4 @@ def createMesh():
if beVerbose == 1:
FreeCAD.Console.PrintMessage("\nScript finished without errors.")
# @}
## @}

48
src/Mod/Image/Gui/ViewProviderImagePlane.cpp
View File

@@ -23,7 +23,7 @@
#include "PreCompiled.h"
#ifndef _PreComp_
#ifndef _PreComp_
# include <Inventor/SbVec3f.h>
# include <Inventor/nodes/SoSeparator.h>
# include <Inventor/nodes/SoCoordinate3.h>
@@ -42,8 +42,8 @@
#include "ViewProviderImagePlane.h"
#include <Mod/Image/App/ImagePlane.h>
#include <App/Document.h>
#include <Gui/BitmapFactory.h>
#include <App/Document.h>
#include <Gui/BitmapFactory.h>
#include <Base/FileInfo.h>
#include <Base/Stream.h>
#include <Base/Console.h>
@@ -57,7 +57,7 @@ using namespace Image;
PROPERTY_SOURCE(ImageGui::ViewProviderImagePlane, Gui::ViewProviderGeometryObject)
ViewProviderImagePlane::ViewProviderImagePlane()
{
{
texture = new SoTexture2;
texture->ref();
@@ -66,7 +66,7 @@ ViewProviderImagePlane::ViewProviderImagePlane()
}
ViewProviderImagePlane::~ViewProviderImagePlane()
{
{
pcCoords->unref();
texture->unref();
}
@@ -75,9 +75,9 @@ void ViewProviderImagePlane::attach(App::DocumentObject *pcObj)
{
ViewProviderDocumentObject::attach(pcObj);
// NOTE: SoFCSelection node has beem removed because it led to
// problems using the image as a construction plane with the
// draft commands
// NOTE: SoFCSelection node has beem removed because it led to
// problems using the image as a construction plane with the
// draft commands
SoSeparator* planesep = new SoSeparator;
planesep->addChild(pcCoords);
@@ -100,23 +100,23 @@ void ViewProviderImagePlane::attach(App::DocumentObject *pcObj)
SoFaceSet *faceset = new SoFaceSet;
faceset->numVertices.set1Value(0,4);
planesep->addChild(faceset);
addDisplayMaskMode(planesep, "ImagePlane");
addDisplayMaskMode(planesep, "ImagePlane");
}
void ViewProviderImagePlane::setDisplayMode(const char* ModeName)
{
if (strcmp("ImagePlane",ModeName) == 0)
setDisplayMaskMode("ImagePlane");
ViewProviderGeometryObject::setDisplayMode(ModeName);
}
std::vector<std::string> ViewProviderImagePlane::getDisplayModes(void) const
{
std::vector<std::string> StrList;
StrList.push_back("ImagePlane");
return StrList;
}
void ViewProviderImagePlane::setDisplayMode(const char* ModeName)
{
if (strcmp("ImagePlane",ModeName) == 0)
setDisplayMaskMode("ImagePlane");
ViewProviderGeometryObject::setDisplayMode(ModeName);
}
std::vector<std::string> ViewProviderImagePlane::getDisplayModes(void) const
{
std::vector<std::string> StrList;
StrList.push_back("ImagePlane");
return StrList;
}
bool ViewProviderImagePlane::loadSvg(const char* filename, float x, float y, QImage& img)
{

8
src/Mod/Part/App/FeaturePartBox.cpp
View File

@@ -184,10 +184,10 @@ void Box::Restore(Base::XMLReader &reader)
else if (location_axis) {
Base::Vector3d d = Axis.getValue();
Base::Vector3d p = Location.getValue();
Base::Rotation rot(Base::Vector3d(0.0,0.0,1.0),
Base::Vector3d(d.x,d.y,d.z));
plm.setRotation(rot);
plm.setPosition(Base::Vector3d(p.x,p.y,p.z));
Base::Rotation rot(Base::Vector3d(0.0,0.0,1.0),
Base::Vector3d(d.x,d.y,d.z));
plm.setRotation(rot);
plm.setPosition(Base::Vector3d(p.x,p.y,p.z));
this->Placement.setValue(this->Placement.getValue() * plm);
this->Shape.setStatus(App::Property::User1, true); // override the shape's location later on
}

2
src/Mod/Part/AttachmentEditor/Commands.py
View File

@@ -1,4 +1,4 @@
#/***************************************************************************
# ***************************************************************************
# * Copyright (c) Victor Titov (DeepSOIC) *
# * (vv.titov@gmail.com) 2016 *
# * *

2
src/Mod/PartDesign/Gui/Utils.h
View File

@@ -23,7 +23,7 @@
#ifndef UTILS_H_CS5LK2ZQ
#define UTILS_H_CS5LK2ZQ
/** \file Utils.h
/** \file PartDesign/Gui/Utils.h
* This fiel contains some utility function used over PartDesignGui module
*/
namespace PartDesign {

10
src/Mod/Spreadsheet/App/Cell.cpp
View File

@@ -72,10 +72,8 @@ const int Cell::ALIGNMENT_VERTICAL = 0xf0;
/**
* Construct a CellContent object.
*
* @param _row The row of the cell in the spreadsheet that contains is.
* @param _col The column of the cell in the spreadsheet that contains is.
* @param _owner The spreadsheet that owns this cell.
* @param _address The adress of the caell
* @param _owner The spreadsheet that owns this cell.
*
*/
@@ -758,7 +756,7 @@ std::string Cell::encodeAlignment(int alignment)
}
/**
* Encode \a color as a #rrggbbaa string.
* Encode \a color as a \#rrggbbaa string.
*
* @param color Color to encode.
*
@@ -805,7 +803,7 @@ std::string Cell::encodeStyle(const std::set<std::string> & style)
}
/**
* Decode a string of the format #rrggbb or #rrggbbaa into a Color.
* Decode a string of the format \#rrggbb or \#rrggbbaa into a Color.
*
* @param color The color to decode.
* @param defaultColor A default color in case the decoding fails.

10
src/Mod/Spreadsheet/App/Sheet.cpp
View File

@@ -476,7 +476,7 @@ void Sheet::onSettingDocument()
}
/**
* Set the property for cell \key to a PropertyFloat with the value \a value.
* Set the property for cell \p key to a PropertyFloat with the value \a value.
* If the Property exists, but of wrong type, the previous Property is destroyed and recreated as the correct type.
*
* @param key The address of the cell we want to create a Property for
@@ -506,7 +506,7 @@ Property * Sheet::setFloatProperty(CellAddress key, double value)
}
/**
* Set the property for cell \key to a PropertyQuantity with \a value and \a unit.
* Set the property for cell \p key to a PropertyQuantity with \a value and \a unit.
* If the Property exists, but of wrong type, the previous Property is destroyed and recreated as the correct type.
*
* @param key The address of the cell we want to create a Property for
@@ -541,7 +541,7 @@ Property * Sheet::setQuantityProperty(CellAddress key, double value, const Base:
}
/**
* Set the property for cell \key to a PropertyString with \a value.
* Set the property for cell \p key to a PropertyString with \a value.
* If the Property exists, but of wrong type, the previous Property is destroyed and recreated as the correct type.
*
* @param key The address of the cell we want to create a Property for
@@ -916,7 +916,7 @@ void Sheet::getSpans(CellAddress address, int &rows, int &cols) const
/**
* Determine whether this cell is merged with another or not.
*
* @param adderss
* @param address
*
* @returns True if cell is merged, false if not.
*
@@ -950,7 +950,7 @@ int Sheet::getColumnWidth(int col) const
}
/**
* @brief Set row height of row given by index in \row to \a height.
* @brief Set row height of row given by index in \p row to \a height.
* @param row Row index.
* @param height New height of row.
*/

2
src/Mod/TechDraw/App/DrawProjGroup.h
View File

@@ -139,7 +139,7 @@ protected:
/// Annoying helper - keep in sync with DrawProjGroupItem::TypeEnums
/*!
* \TODO See note regarding App::PropertyEnumeration on my wiki page http://freecadweb.org/wiki/index.php?title=User:Ian.rees
* \todo {See note regarding App::PropertyEnumeration on my wiki page http://freecadweb.org/wiki/index.php?title=User:Ian.rees}
* \return true iff 'in' is a valid name for an orthographic/isometric view
*/
bool checkViewProjType(const char *in);