View Issue Details
ID | Project | Category | View Status | Date Submitted | Last Update |
---|---|---|---|---|---|
0002495 | Slicer4 | Core: Documentation and Wiki | public | 2012-09-11 10:46 | 2014-03-06 05:13 |
Reporter | mccormic | Assigned To | mccormic | ||
Priority | normal | Severity | minor | Reproducibility | have not tried |
Status | closed | Resolution | fixed | ||
Product Version | |||||
Target Version | Slicer 4.2.0 | Fixed in Version | Slicer 4.2.0 | ||
Summary | 0002495: Doxygen HTML does not contain class descriptions. | ||||
Description | Even though there are class descriptions in many of the MRML headers, they do not show up in the Doxygen html output. | ||||
Tags | No tags attached. | ||||
Mailing list notes: There two valid, tested formats that will add the class documentation The original: /*=auto========================================================================= Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH) All See COPYRIGHT.txt Program: 3D Slicer =========================================================================auto=*/ #include "vtkMRMLNode.h" class VTK_MRML_EXPORT vtkMRMLChartViewNode : public vtkMRMLNode Option 1, adding \class, newline, \brief: /*=auto========================================================================= Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH) All See COPYRIGHT.txt Program: 3D Slicer =========================================================================auto=*/ #include "vtkMRMLNode.h" class VTK_MRML_EXPORT vtkMRMLChartViewNode : public vtkMRMLNode Option 2, move the documentation past the #include's above the class /*=auto========================================================================= Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH) All See COPYRIGHT.txt Program: 3D Slicer =========================================================================auto=*/ #include "vtkMRMLNode.h" /// \brief MRML node to represent chart view parameters. Hi Matt, Thanks for investigating. +1 for "Option 2" Jc |
|
Fixes committed in r21001-r21010. Awaiting doxygen website update. |
|
Closing resolved issues that have not been updated in more than 3 months |
|
Date Modified | Username | Field | Change |
---|---|---|---|
2012-09-11 10:46 | mccormic | New Issue | |
2012-09-11 10:46 | mccormic | Status | new => assigned |
2012-09-11 10:46 | mccormic | Assigned To | => jcfr |
2012-09-11 10:46 | mccormic | Assigned To | jcfr => mccormic |
2012-09-16 15:39 | mccormic | Note Added: 0006102 | |
2012-09-18 16:52 | mccormic | Note Added: 0006134 | |
2012-09-18 16:52 | mccormic | Status | assigned => resolved |
2012-09-18 16:52 | mccormic | Fixed in Version | => Slicer 4.2.0 - coming release |
2012-09-18 16:52 | mccormic | Resolution | open => fixed |
2012-12-08 09:56 | jcfr | Target Version | => Slicer 4.2.0 |
2014-03-06 05:12 | jcfr | Note Added: 0011017 | |
2014-03-06 05:13 | jcfr | Status | resolved => closed |
2016-06-20 14:15 | jcfr | Category | Core: Documentation & Wiki => Core: Documentation and Wiki |