0030129: With newest doxygen 1.8.14 generation of overview gives warnings

Doxygen configuration scripts are corrected to avoid '\n' symbols in the end of the @figure alias that caused multiple warning messages.
Other Doxygen warnings in Markdown files are eliminated.
In CMake builds the format of Doxygen warnings is set to use the style recognized by Visual Studio when compiler is MSVC.

diff --git a/dox/CMakeLists.txt b/dox/CMakeLists.txt
index c489f3a..48a9552 100644 (file)
--- a/dox/CMakeLists.txt
+++ b/dox/CMakeLists.txt
@@ -89,6 +89,14 @@ file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nEXTERNAL_SEARCH        = NO")
 # Formula options
 file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nMATHJAX_RELPATH        = ${3RDPARTY_MATHJAX_RELATIVE_PATH}")
 
+# If MSVC is used as build system, change warning format to the one recognized by MSVC
+if (MSVC)
+  file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nWARN_FORMAT            = \"$file($line): $text\"")
+endif()
+
+# Avoid Doxygen parsing messages in the build log
+file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nQUIET                  = YES")
+
 # Copy index file to provide fast access to HTML documentation
 file(COPY "${OCCT_OVERVIEW_RESOURCE_DIR}/index.html" DESTINATION "${OCCT_GENERATED_OVERVIEW_DIR}")
 

diff --git a/dox/resources/occt_ug_html.doxyfile b/dox/resources/occt_ug_html.doxyfile
index 4852f72..a3a5772 100644 (file)
--- a/dox/resources/occt_ug_html.doxyfile
+++ b/dox/resources/occt_ug_html.doxyfile
@@ -16,7 +16,6 @@ WARNINGS               = YES
 WARN_IF_UNDOCUMENTED   = YES
 WARN_IF_DOC_ERROR      = YES
 WARN_NO_PARAMDOC       = NO
-WARN_FORMAT            = \\$file:\$line: \$text\
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.md *.dox 
 RECURSIVE              = YES
@@ -56,6 +55,6 @@ USE_MATHJAX            = YES
 MATHJAX_FORMAT         = HTML-CSS
 
 # Define alias for inserting images in uniform way (both HTML and PDF)
-ALIASES += figure{1}="\image html \1 \n"
-ALIASES += figure{2}="\image html \1 \2 \n"
-ALIASES += figure{3}="\image html \1 \2 \n"
+ALIASES += figure{1}="\image html \1"
+ALIASES += figure{2}="\image html \1 \2"
+ALIASES += figure{3}="\image html \1 \2"

diff --git a/dox/resources/occt_ug_pdf.doxyfile b/dox/resources/occt_ug_pdf.doxyfile
index b158bef..5fff37a 100644 (file)
--- a/dox/resources/occt_ug_pdf.doxyfile
+++ b/dox/resources/occt_ug_pdf.doxyfile
@@ -16,7 +16,6 @@ WARNINGS               = YES
 WARN_IF_UNDOCUMENTED   = YES
 WARN_IF_DOC_ERROR      = YES
 WARN_NO_PARAMDOC       = NO
-WARN_FORMAT            = \\$file:\$line: \$text\
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.md *.dox 
 RECURSIVE              = YES
@@ -49,6 +48,6 @@ LATEX_CMD_NAME         = latex
 MAKEINDEX_CMD_NAME     = makeindex
 
 # Define alias for inserting images in uniform way (both HTML and PDF)
-ALIASES += figure{1}="\image latex \1 \n"
-ALIASES += figure{2}="\image latex \1 \2 \n"
-ALIASES += figure{3}="\image latex \1 \2 width=\3 \n"
+ALIASES += figure{1}="\image latex \1"
+ALIASES += figure{2}="\image latex \1 \2"
+ALIASES += figure{3}="\image latex \1 \2 width=\3"

diff --git a/dox/user_guides/iges/iges.md b/dox/user_guides/iges/iges.md
index 5743eac..ab891fb 100644 (file)
--- a/dox/user_guides/iges/iges.md
+++ b/dox/user_guides/iges/iges.md
@@ -178,10 +178,10 @@ if  (!Interface_Static::SetRVal ("read.maxprecision.val",0.1))
 Default value is 1.  
 
 <h4>read.stdsameparameter.mode</h4>
-defines the using of  *BRepLib::SameParameter*. Its possible values are:  
-* 0 (Off) -- *BRepLib::SameParameter* is not called,  
-* 1 (On) -- *BRepLib::SameParameter* is called.  
-*BRepLib::SameParameter* is used through  *ShapeFix_Edge::SameParameter*. It ensures that the resulting edge will have the  lowest tolerance taking pcurves either unmodified from the IGES file or  modified by *BRepLib::SameParameter*.  
+defines the using of  *BRepLib\::SameParameter*. Its possible values are:  
+* 0 (Off) -- *BRepLib\::SameParameter* is not called,  
+* 1 (On) -- *BRepLib\::SameParameter* is called.  
+*BRepLib\::SameParameter* is used through  *ShapeFix_Edge\::SameParameter*. It ensures that the resulting edge will have the  lowest tolerance taking pcurves either unmodified from the IGES file or  modified by *BRepLib\::SameParameter*.  
 Read this parameter  with:  
 ~~~~~
 Standard_Integer mv =  Interface_Static::IVal("read.stdsameparameter.mode"); 
@@ -202,7 +202,7 @@ The processor also  decides to re-compute either the 3D or the 2D curve even if
   * the number of sub-curves in  the 2D curve is different from the number of sub-curves in the 3D curve. This  can be either due to different numbers of sub-curves given in the IGES file or  because of splitting of curves during translation. 
   * 3D or 2D curve is a Circular  Arc (entity type 100) starting and ending in the same point (note that this  case is incorrect according to the IGES standard).
   
-The parameter  *read.surfacecurve.mode* defines which curve (3D or 2D) is used for re-computing  the other one:  
+The parameter  *read.surfacecurve.mode* defines which curve (3D or 2D) is used for re-computing  the other one:
 * *Default(0)* use  the preference flag value in the entity's Parameter Data section. The flag  values are:  
   * 0: no preference given, 
   * 1: use 2D for 142 entities  and 3D for 141 entities, 
@@ -400,12 +400,12 @@ reader.PrintTransferInfo  (failsonly, mode);
 ~~~~~
 displays the messages  that appeared during the last invocation of *Transfer* or *TransferRoots*.  
 
-If *failsonly* is  *IFSelect_FailOnly*, only fail messages will be output, if it is  *IFSelect_FailAndWarn*, all messages will be output. Parameter “mode” can have  *IFSelect_xxx* values where *xxx* can be:  
-* *GeneralCount* -- gives general statistics  on the transfer (number of translated IGES entities, number of fails and  warnings, etc)  
-* *CountByItem* -- gives the number of IGES  entities with their types per message. 
-* *ListByItem* -- gives the number of IGES  entities with their type and DE numbers per message.  
-* *ResultCount*  -- gives the number of  resulting OCCT shapes per type.  
-* *Mapping* -- gives mapping between  roots of the IGES file and the resulting OCCT shape per IGES and OCCT type.
+If *failsonly* is  *IFSelect_FailOnly*, only fail messages will be output, if it is  *IFSelect_FailAndWarn*, all messages will be output. Parameter “mode” can have  *IFSelect_xxx* values where *xxx* can be:
+  * *GeneralCount* -- gives general statistics  on the transfer (number of translated IGES entities, number of fails and  warnings, etc)  
+  * *CountByItem* -- gives the number of IGES  entities with their types per message. 
+  * *ListByItem* -- gives the number of IGES  entities with their type and DE numbers per message.  
+  * *ResultCount*  -- gives the number of  resulting OCCT shapes per type.  
+  * *Mapping* -- gives mapping between  roots of the IGES file and the resulting OCCT shape per IGES and OCCT type.
  
 @subsection occt_iges_2_4 Mapping of IGES  entities to Open CASCADE Technology shapes