View Issue Details

IDProjectCategoryView StatusLast Update
0002495Slicer4Core: Documentation and Wikipublic2014-03-06 05:13
Reportermccormic Assigned Tomccormic  
PrioritynormalSeverityminorReproducibilityhave not tried
Status closedResolutionfixed 
Product Version 
Target VersionSlicer 4.2.0Fixed in VersionSlicer 4.2.0 
Summary0002495: 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.

http://slicer.org/doc/html/classes.html

TagsNo tags attached.

Activities

mccormic

mccormic

2012-09-16 15:39

developer   ~0006102

Mailing list notes:

There two valid, tested formats that will add the class documentation
to the HTML output with the brief message at the top.

The original:

/*=auto=========================================================================

Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH) All
Rights Reserved.

See COPYRIGHT.txt
or http://www.slicer.org/copyright/copyright.txt for details.

Program: 3D Slicer
Module: $RCSfile: vtkMRMLChartNode.h,v $
Date: $Date: 2006/03/19 17:12:29 $
Version: $Revision: 1.3 $

=========================================================================auto=*/
/// vtkMRMLChartViewNode - MRML node to represent chart view parameters.
///
/// ChartViewNodes are associated one to one with a ChartWidget.
///
#ifndef __vtkMRMLChartViewNode_h
#define __vtkMRMLChartViewNode_h

#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
Rights Reserved.

See COPYRIGHT.txt
or http://www.slicer.org/copyright/copyright.txt for details.

Program: 3D Slicer
Module: $RCSfile: vtkMRMLChartNode.h,v $
Date: $Date: 2006/03/19 17:12:29 $
Version: $Revision: 1.3 $

=========================================================================auto=*/
/// \class vtkMRMLChartViewNode
/// \brief MRML node to represent chart view parameters.
///
/// ChartViewNodes are associated one to one with a ChartWidget.
///
#ifndef __vtkMRMLChartViewNode_h
#define __vtkMRMLChartViewNode_h

#include "vtkMRMLNode.h"

class VTK_MRML_EXPORT vtkMRMLChartViewNode : public vtkMRMLNode
{

Option 2, move the documentation past the #include's above the class
declaration:

/*=auto=========================================================================

Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH) All
Rights Reserved.

See COPYRIGHT.txt
or http://www.slicer.org/copyright/copyright.txt for details.

Program: 3D Slicer
Module: $RCSfile: vtkMRMLChartNode.h,v $
Date: $Date: 2006/03/19 17:12:29 $
Version: $Revision: 1.3 $

=========================================================================auto=*/
#ifndef __vtkMRMLChartViewNode_h
#define __vtkMRMLChartViewNode_h

#include "vtkMRMLNode.h"

/// \brief MRML node to represent chart view parameters.
///
/// ChartViewNodes are associated one to one with a ChartWidget.
///
class VTK_MRML_EXPORT vtkMRMLChartViewNode : public vtkMRMLNode
{

Hi Matt,

Thanks for investigating.

+1 for "Option 2"

Jc

mccormic

mccormic

2012-09-18 16:52

developer   ~0006134

Fixes committed in r21001-r21010. Awaiting doxygen website update.

jcfr

jcfr

2014-03-06 05:12

administrator   ~0011017

Closing resolved issues that have not been updated in more than 3 months

Issue History

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