DiscussionsIssue archiveOCCT:Documentation

Archived issue #0031366

Documentation - Doxygen warnings in Standard_Dump.hxx

Open CASCADEOCCT:Documentationclosed5 public notes

Search issues

Description

After correction of #0031363, some Doxygen warings are still present in Standard_Dump.hxx:

src/Standard/Standard_Dump.hxx:217: warning: Unsupported xml/html tag <class_name> found
src/Standard/Standard_Dump.hxx:217: warning: Found unknown command `\value_1'
src/Standard/Standard_Dump.hxx:217: warning: Found unknown command `\key_2'
src/Standard/Standard_Dump.hxx:217: warning: Found unknown command `\value_2'
src/Standard/Standard_Dump.hxx:217: warning: Unsupported xml/html tag </class_name> found
src/Standard/Standard_Dump.hxx:220: warning: Unsupported xml/html tag <class_name> found
src/Standard/Standard_Dump.hxx:220: warning: Found unknown command `\value_1'
src/Standard/Standard_Dump.hxx:220: warning: Found unknown command `\key_2'
src/Standard/Standard_Dump.hxx:220: warning: Found unknown command `\value_2'
src/Standard/Standard_Dump.hxx:220: warning: Found unknown command `\key_3'
src/Standard/Standard_Dump.hxx:220: warning: Unsupported xml/html tag <subclass_name> found
src/Standard/Standard_Dump.hxx:220: warning: Found unknown command `\subclass_value1'
src/Standard/Standard_Dump.hxx:220: warning: Unsupported xml/html tag </subclass_name> found
src/Standard/Standard_Dump.hxx:220: warning: Unsupported xml/html tag </class_name> found
src/Standard/Standard_Dump.hxx:222: warning: Unsupported xml/html tag <subclass_name> found
src/Standard/Standard_Dump.hxx:222: warning: Found unknown command `\subclass_value1'
src/Standard/Standard_Dump.hxx:222: warning: Unsupported xml/html tag </subclass_name> found
src/Standard/Standard_Dump.hxx:217: warning: argument 'theStream' of command @param is not found in the argument list of Standard_Dump::SplitJson(const TCollection_AsciiString &theStreamStr, NCollection_IndexedDataMap< TCollection_AsciiString, Standard_DumpValue > &theKeyToValues)
src/Standard/Standard_Dump.hxx:229: warning: The following parameters of Standard_Dump::SplitJson(const TCollection_AsciiString &theStreamStr, NCollection_IndexedDataMap< TCollection_AsciiString, Standard_DumpValue > &theKeyToValues) are not documented: parameter 'theStreamStr'

Steps to reproduce

gendoc.bat -refman -m=FoundationClasses

then see Doxygen errors in doc/html_doxygen_err.log

Public activity

5 archived notes

Participants are labeled by their role within this record.

01Commenter 2
Branch [archived branch] has been created by Commenter 3.

[revision removed]


Detailed log of new commits:

Author: Commenter 3
Date: Tue Feb 18 08:53:37 2020 +0300

    0031366: Documentation - Doxygen warnings in Standard_Dump.hxx
02Commenter 3
Dear Andrey

Please review.
Jenkins job: http://jenkins-test-12.nnov.opencascade.com/view/CR31366-master-NDS/
Thank you for "Steps to reproduce" filled.

[signature removed]Natalia
03Commenter 4
Dear Commenter 1,

please verify the fix (Doxygen warnings being eliminated).
04Commenter 1
Fix has been tested in framework of IR-2020-02-22

Combination -
OCCT branch : [archived branch]
master SHA - [revision removed]
[revision removed]
Products branch : [archived branch] SHA - [revision removed]
was compiled on Linux, MacOS and Windows platforms and tested in optimize mode.

Number of compiler warnings:
No new/fixed warnings

Regressions/Differences/Improvements:
No regressions/differences

CPU differences:
Debian80-64:
OCCT
Total CPU difference: 17017.87000000002 / 17024.610000000095 [-0.04%]
Products
Total CPU difference: 12533.37000000014 / 12614.3600000001 [-0.64%]
Windows-64-VC14:
OCCT
Total CPU difference: 18397.9375 / 18472.453125 [-0.40%]
Products
Total CPU difference: 14483.234375 / 14513.703125 [-0.21%]


Image differences :
No differences that require special attention

Memory differences :
No differences that require special attention
05Commenter 2
Branch [archived branch] has been deleted by Participant.

[revision removed]

Related records