From 201c9d89b0957cffc3fe4f89c506491889f3640c Mon Sep 17 00:00:00 2001 From: hgutsche Date: Mon, 27 Feb 2017 10:29:05 -0500 Subject: [PATCH] Some fixes for doygen syntax errors and some configuration to make it run smoother under Windows --- src/App/Range.cpp | 4 +- src/Base/Reader.h | 4 +- src/Doc/BuildDevDoc.cfg.in | 29 +++++++----- src/Doc/CMakeLists.txt | 10 ++-- src/Doc/FreecadDoxygenLayout.xml | 2 +- src/Gui/Quarter/Quarter.cpp | 33 +++++++------- src/Mod/Draft/App/AppDraftUtilsPy.cpp | 4 +- src/Mod/Draft/Draft.py | 2 +- src/Mod/Draft/DraftGeomUtils.py | 2 +- src/Mod/Draft/DraftVecUtils.py | 2 +- src/Mod/Fem/App/FemMeshObject.cpp | 2 + src/Mod/Fem/App/FemSolverObject.cpp | 2 +- src/Mod/Fem/FemGmshTools.py | 2 +- src/Mod/Fem/FemInputWriter.py | 2 +- src/Mod/Fem/FemInputWriterZ88.py | 2 +- src/Mod/Fem/FemMeshTools.py | 2 +- src/Mod/Fem/FemSelectionObserver.py | 2 +- src/Mod/Fem/FemTools.py | 2 +- src/Mod/Fem/FemToolsCcx.py | 2 +- src/Mod/Fem/FemToolsZ88.py | 2 +- src/Mod/Fem/ObjectsFem.py | 2 +- src/Mod/Fem/PyGui/FemCommands.py | 2 +- src/Mod/Fem/convert2TetGen.py | 2 +- src/Mod/Image/Gui/ViewProviderImagePlane.cpp | 48 ++++++++++---------- src/Mod/Part/App/FeaturePartBox.cpp | 8 ++-- src/Mod/Part/AttachmentEditor/Commands.py | 2 +- src/Mod/PartDesign/Gui/Utils.h | 2 +- src/Mod/Spreadsheet/App/Cell.cpp | 10 ++-- src/Mod/Spreadsheet/App/Sheet.cpp | 10 ++-- src/Mod/TechDraw/App/DrawProjGroup.h | 2 +- 30 files changed, 103 insertions(+), 97 deletions(-) diff --git a/src/App/Range.cpp b/src/App/Range.cpp index d298e3d42f..f178f8b572 100644 --- a/src/App/Range.cpp +++ b/src/App/Range.cpp @@ -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. * */ diff --git a/src/Base/Reader.h b/src/Base/Reader.h index 0de40d18cc..2195ab42f2 100644 --- a/src/Base/Reader.h +++ b/src/Base/Reader.h @@ -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) diff --git a/src/Doc/BuildDevDoc.cfg.in b/src/Doc/BuildDevDoc.cfg.in index 63526ddb3f..11f437997d 100644 --- a/src/Doc/BuildDevDoc.cfg.in +++ b/src/Doc/BuildDevDoc.cfg.in @@ -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 diff --git a/src/Doc/CMakeLists.txt b/src/Doc/CMakeLists.txt index e9d7ad6f4e..7e3ef8bfdd 100644 --- a/src/Doc/CMakeLists.txt +++ b/src/Doc/CMakeLists.txt @@ -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 ) diff --git a/src/Doc/FreecadDoxygenLayout.xml b/src/Doc/FreecadDoxygenLayout.xml index b759d4614f..49194389a5 100644 --- a/src/Doc/FreecadDoxygenLayout.xml +++ b/src/Doc/FreecadDoxygenLayout.xml @@ -17,7 +17,7 @@ - + diff --git a/src/Gui/Quarter/Quarter.cpp b/src/Gui/Quarter/Quarter.cpp index 2a40a539c2..9442f53b44 100644 --- a/src/Gui/Quarter/Quarter.cpp +++ b/src/Gui/Quarter/Quarter.cpp @@ -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 #include diff --git a/src/Mod/Draft/App/AppDraftUtilsPy.cpp b/src/Mod/Draft/App/AppDraftUtilsPy.cpp index c334c444c3..2966113093 100644 --- a/src/Mod/Draft/App/AppDraftUtilsPy.cpp +++ b/src/Mod/Draft/App/AppDraftUtilsPy.cpp @@ -22,8 +22,8 @@ #include "PreCompiled.h" -#ifndef _PreComp_ -# include +#ifndef _PreComp_ +# include #endif #include diff --git a/src/Mod/Draft/Draft.py b/src/Mod/Draft/Draft.py index d340d0e862..b9c98b738e 100644 --- a/src/Mod/Draft/Draft.py +++ b/src/Mod/Draft/Draft.py @@ -6227,4 +6227,4 @@ class ViewProviderWorkingPlaneProxy: return None -# @} +## @} diff --git a/src/Mod/Draft/DraftGeomUtils.py b/src/Mod/Draft/DraftGeomUtils.py index a7c21c126f..57bd3c07f2 100755 --- a/src/Mod/Draft/DraftGeomUtils.py +++ b/src/Mod/Draft/DraftGeomUtils.py @@ -2815,4 +2815,4 @@ def circleInversion(circle, circle2): FreeCAD.Console.PrintMessage("debug: circleInversion bad parameters!\n") return None -# @} +## @} diff --git a/src/Mod/Draft/DraftVecUtils.py b/src/Mod/Draft/DraftVecUtils.py index f8db606d17..1bfb5560d1 100644 --- a/src/Mod/Draft/DraftVecUtils.py +++ b/src/Mod/Draft/DraftVecUtils.py @@ -252,4 +252,4 @@ def removeDoubles(vlist): nlist.append(vlist[-1]) return nlist -# @} +## @} diff --git a/src/Mod/Fem/App/FemMeshObject.cpp b/src/Mod/Fem/App/FemMeshObject.cpp index 57a5ce7cda..9465ed7527 100644 --- a/src/Mod/Fem/App/FemMeshObject.cpp +++ b/src/Mod/Fem/App/FemMeshObject.cpp @@ -92,4 +92,6 @@ template<> PyObject* Fem::FemMeshObjectPython::getPyObject(void) { // explicit template instantiation template class AppFemExport FeaturePythonT; +/// @endcond + } diff --git a/src/Mod/Fem/App/FemSolverObject.cpp b/src/Mod/Fem/App/FemSolverObject.cpp index c318a3f2eb..38b5485123 100644 --- a/src/Mod/Fem/App/FemSolverObject.cpp +++ b/src/Mod/Fem/App/FemSolverObject.cpp @@ -77,7 +77,7 @@ template<> PyObject* Fem::FemSolverObjectPython::getPyObject(void) { } return Py::new_reference_to(PythonObject); } - +/// @endcond // explicit template instantiation template class AppFemExport FeaturePythonT; diff --git a/src/Mod/Fem/FemGmshTools.py b/src/Mod/Fem/FemGmshTools.py index 9aec843140..e7cc8c2b70 100644 --- a/src/Mod/Fem/FemGmshTools.py +++ b/src/Mod/Fem/FemGmshTools.py @@ -425,4 +425,4 @@ class FemGmshTools(): del self.temp_file_geometry del self.temp_file_mesh -# @} +## @} diff --git a/src/Mod/Fem/FemInputWriter.py b/src/Mod/Fem/FemInputWriter.py index f6a8d51d1d..f6f0604d06 100644 --- a/src/Mod/Fem/FemInputWriter.py +++ b/src/Mod/Fem/FemInputWriter.py @@ -177,4 +177,4 @@ class FemInputWriter(): femobj['PressureFaces'] = [(femobj['Object'].Name + ': face load', pressure_faces)] # print(femobj['PressureFaces']) -# @} +## @} diff --git a/src/Mod/Fem/FemInputWriterZ88.py b/src/Mod/Fem/FemInputWriterZ88.py index 65a1b8fdc3..26b1ab4435 100644 --- a/src/Mod/Fem/FemInputWriterZ88.py +++ b/src/Mod/Fem/FemInputWriterZ88.py @@ -319,4 +319,4 @@ Entries for Cuthill-McKee Z88H Daten fuer Cuthill- McKee Programm DYNAMIC END ''' -# @} +## @} diff --git a/src/Mod/Fem/FemMeshTools.py b/src/Mod/Fem/FemMeshTools.py index 10e6cfa861..a54c948d78 100644 --- a/src/Mod/Fem/FemMeshTools.py +++ b/src/Mod/Fem/FemMeshTools.py @@ -1507,4 +1507,4 @@ def use_correct_fluidinout_ele_def(FluidInletoutlet_ele, fileName): f.close() inout_nodes_file.close() -# @} +## @} diff --git a/src/Mod/Fem/FemSelectionObserver.py b/src/Mod/Fem/FemSelectionObserver.py index 7e9dc9c5c7..cbe2310c23 100644 --- a/src/Mod/Fem/FemSelectionObserver.py +++ b/src/Mod/Fem/FemSelectionObserver.py @@ -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) -# @} +## @} diff --git a/src/Mod/Fem/FemTools.py b/src/Mod/Fem/FemTools.py index ad1455682d..6943e03b67 100644 --- a/src/Mod/Fem/FemTools.py +++ b/src/Mod/Fem/FemTools.py @@ -577,4 +577,4 @@ class FemTools(QtCore.QRunnable, QtCore.QObject): stats = match[result_type] return stats -# @} +## @} diff --git a/src/Mod/Fem/FemToolsCcx.py b/src/Mod/Fem/FemToolsCcx.py index 32489f46e6..b6655c9d0d 100644 --- a/src/Mod/Fem/FemToolsCcx.py +++ b/src/Mod/Fem/FemToolsCcx.py @@ -265,4 +265,4 @@ class FemToolsCcx(FemTools.FemTools): if m.Eigenmode == mf['eigenmode']: m.EigenmodeFrequency = mf['frequency'] -# @} +## @} diff --git a/src/Mod/Fem/FemToolsZ88.py b/src/Mod/Fem/FemToolsZ88.py index 732c1d9959..b12fe8198a 100644 --- a/src/Mod/Fem/FemToolsZ88.py +++ b/src/Mod/Fem/FemToolsZ88.py @@ -202,4 +202,4 @@ class FemToolsZ88(FemTools.FemTools): else: raise Exception('FEM: No results found at {}!'.format(disp_result_file)) -# @} +## @} diff --git a/src/Mod/Fem/ObjectsFem.py b/src/Mod/Fem/ObjectsFem.py index 4e720cf6b9..29678dbdd6 100644 --- a/src/Mod/Fem/ObjectsFem.py +++ b/src/Mod/Fem/ObjectsFem.py @@ -315,4 +315,4 @@ for s in sorted(App.ActiveDocument.supportedTypes()): print s ''' -# @} +## @} diff --git a/src/Mod/Fem/PyGui/FemCommands.py b/src/Mod/Fem/PyGui/FemCommands.py index 8f86a9c5ce..230e997e41 100644 --- a/src/Mod/Fem/PyGui/FemCommands.py +++ b/src/Mod/Fem/PyGui/FemCommands.py @@ -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 -# @} +## @} diff --git a/src/Mod/Fem/convert2TetGen.py b/src/Mod/Fem/convert2TetGen.py index f0cfbf8ada..f25ad7a225 100755 --- a/src/Mod/Fem/convert2TetGen.py +++ b/src/Mod/Fem/convert2TetGen.py @@ -264,4 +264,4 @@ def createMesh(): if beVerbose == 1: FreeCAD.Console.PrintMessage("\nScript finished without errors.") -# @} +## @} diff --git a/src/Mod/Image/Gui/ViewProviderImagePlane.cpp b/src/Mod/Image/Gui/ViewProviderImagePlane.cpp index b1292f1f74..54a6d8849e 100644 --- a/src/Mod/Image/Gui/ViewProviderImagePlane.cpp +++ b/src/Mod/Image/Gui/ViewProviderImagePlane.cpp @@ -23,7 +23,7 @@ #include "PreCompiled.h" -#ifndef _PreComp_ +#ifndef _PreComp_ # include # include # include @@ -42,8 +42,8 @@ #include "ViewProviderImagePlane.h" #include -#include -#include +#include +#include #include #include #include @@ -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 ViewProviderImagePlane::getDisplayModes(void) const +{ + std::vector 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 ViewProviderImagePlane::getDisplayModes(void) const -{ - std::vector StrList; - StrList.push_back("ImagePlane"); - return StrList; -} bool ViewProviderImagePlane::loadSvg(const char* filename, float x, float y, QImage& img) { diff --git a/src/Mod/Part/App/FeaturePartBox.cpp b/src/Mod/Part/App/FeaturePartBox.cpp index 64152a7452..fb1e746076 100644 --- a/src/Mod/Part/App/FeaturePartBox.cpp +++ b/src/Mod/Part/App/FeaturePartBox.cpp @@ -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 } diff --git a/src/Mod/Part/AttachmentEditor/Commands.py b/src/Mod/Part/AttachmentEditor/Commands.py index fe9a6c798e..c88012f855 100644 --- a/src/Mod/Part/AttachmentEditor/Commands.py +++ b/src/Mod/Part/AttachmentEditor/Commands.py @@ -1,4 +1,4 @@ -#/*************************************************************************** +# *************************************************************************** # * Copyright (c) Victor Titov (DeepSOIC) * # * (vv.titov@gmail.com) 2016 * # * * diff --git a/src/Mod/PartDesign/Gui/Utils.h b/src/Mod/PartDesign/Gui/Utils.h index 79b4ae0354..246f093e36 100644 --- a/src/Mod/PartDesign/Gui/Utils.h +++ b/src/Mod/PartDesign/Gui/Utils.h @@ -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 { diff --git a/src/Mod/Spreadsheet/App/Cell.cpp b/src/Mod/Spreadsheet/App/Cell.cpp index 9855c09f66..1498948543 100644 --- a/src/Mod/Spreadsheet/App/Cell.cpp +++ b/src/Mod/Spreadsheet/App/Cell.cpp @@ -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 & 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. diff --git a/src/Mod/Spreadsheet/App/Sheet.cpp b/src/Mod/Spreadsheet/App/Sheet.cpp index a6e50b96ab..06d61f7624 100644 --- a/src/Mod/Spreadsheet/App/Sheet.cpp +++ b/src/Mod/Spreadsheet/App/Sheet.cpp @@ -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. */ diff --git a/src/Mod/TechDraw/App/DrawProjGroup.h b/src/Mod/TechDraw/App/DrawProjGroup.h index e93d0dea7b..10d32ac0d3 100644 --- a/src/Mod/TechDraw/App/DrawProjGroup.h +++ b/src/Mod/TechDraw/App/DrawProjGroup.h @@ -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);