Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a way to generate Doxygen documentation of SlicerRt #265

Merged
merged 3 commits into from
Jan 20, 2025

Conversation

ferdymercury
Copy link
Contributor

@ferdymercury ferdymercury commented Jan 19, 2025

@cpinter

Fixes #35

@ferdymercury
Copy link
Contributor Author

Output looks like:

image

Warnings are:

/tmp/SlicerRt/Beams/Logic/vtkSlicerBeamsModuleLogic.cxx:293: warning: no matching class member found for 
  void vtkSlicerBeamsModuleLogic::UpdateTransformForBeam(vtkMRMLScene *beamSequenceScene, vtkMRMLRTBeamNode *beamNode, vtkMRMLLinearTransformNode *beamTransformNode, double *isocenter)
Possible candidates:
  'void vtkSlicerBeamsModuleLogic::UpdateTransformForBeam(vtkMRMLRTBeamNode *beamNode)'
  'void vtkSlicerBeamsModuleLogic::UpdateTransformForBeam(vtkMRMLScene *beamSequenceScene, vtkMRMLRTBeamNode *beamNode, vtkMRMLLinearTransformNode *beamTransformNode, double isocenter[3])'

/tmp/SlicerRt/Beams/Logic/vtkSlicerMLCPositionLogic.cxx:542: warning: no matching class member found for 
  void vtkSlicerMLCPositionLogic::FindLeafPairRangeIndexes(double *curveBound, vtkTable *mlcTable, int &leafIndexFirst, int &leafIndexLast)
Possible candidates:
  'void vtkSlicerMLCPositionLogic::FindLeafPairRangeIndexes(double curveBound[4], vtkTable *mlcTable, int &leafPairIndexFirst, int &leafPairIndexLast)'
  'void vtkSlicerMLCPositionLogic::FindLeafPairRangeIndexes(vtkMRMLRTBeamNode *beamNode, vtkMRMLTableNode *mlcTableNode, int &leafPairIndexFirst, int &leafPairIndexLast)'

/tmp/SlicerRt/Beams/MRML/vtkMRMLRTBeamNode.cxx:191: warning: documented symbol 'void vtkMRMLRTBeamNode::CopyContent' was not declared or defined.
/tmp/SlicerRt/Beams/MRML/vtkMRMLRTIonBeamNode.cxx:176: warning: documented symbol 'void vtkMRMLRTIonBeamNode::CopyContent' was not declared or defined.
/tmp/SlicerRt/Beams/MRML/vtkMRMLRTPlanNode.cxx:147: warning: documented symbol 'void vtkMRMLRTPlanNode::CopyContent' was not declared or defined.
/tmp/SlicerRt/DrrImageComputation/MRML/vtkMRMLDrrImageComputationNode.cxx:205: warning: documented symbol 'void vtkMRMLDrrImageComputationNode::CopyContent' was not declared or defined.
/tmp/SlicerRt/PlastimatchPy/Logic/vtkPlmpyMismatchError.cxx:54: warning: no uniquely matching class member found for 
  void vtkPlmMismatchError::RunMismatchError()

/tmp/SlicerRt/ExternalBeamPlanning/Widgets/qSlicerAbstractDoseEngine.h:68: warning: argument 'Beam' of command @param is not found in the argument list of qSlicerAbstractDoseEngine::calculateDose(vtkMRMLRTBeamNode *beamNode)
/tmp/SlicerRt/ExternalBeamPlanning/Widgets/qSlicerAbstractDoseEngine.h:71: warning: The following parameter of qSlicerAbstractDoseEngine::calculateDose(vtkMRMLRTBeamNode *beamNode) is not documented:
  parameter 'beamNode'
/tmp/SlicerRt/ExternalBeamPlanning/Widgets/qSlicerAbstractDoseEngine.h:220: warning: The following parameter of qSlicerAbstractDoseEngine::setParameter(vtkMRMLRTBeamNode *beamNode, QString parameterName, bool parameterValue) is not documented:
  parameter 'beamNode'
/tmp/SlicerRt/ExternalBeamPlanning/Widgets/qSlicerAbstractDoseEngine.h:215: warning: The following parameter of qSlicerAbstractDoseEngine::setParameter(vtkMRMLRTBeamNode *beamNode, QString parameterName, double parameterValue) is not documented:
  parameter 'beamNode'
/tmp/SlicerRt/ExternalBeamPlanning/Widgets/qSlicerAbstractDoseEngine.h:207: warning: argument 'name' of command @param is not found in the argument list of qSlicerAbstractDoseEngine::setParameter(vtkMRMLRTBeamNode *beamNode, QString parameterName, int parameterValue)
/tmp/SlicerRt/ExternalBeamPlanning/Widgets/qSlicerAbstractDoseEngine.h:210: warning: The following parameters of qSlicerAbstractDoseEngine::setParameter(vtkMRMLRTBeamNode *beamNode, QString parameterName, int parameterValue) are not documented:
  parameter 'beamNode'
  parameter 'parameterName'
/tmp/SlicerRt/ExternalBeamPlanning/Widgets/qSlicerAbstractDoseEngine.h:205: warning: The following parameter of qSlicerAbstractDoseEngine::setParameter(vtkMRMLRTBeamNode *beamNode, QString parameterName, QString parameterValue) is not documented:
  parameter 'beamNode'
/tmp/SlicerRt/DrrImageComputation/qSlicerDrrImageComputationModuleWidget.h:60: warning: argument 'dimention' of command @param is not found in the argument list of qSlicerDrrImageComputationModuleWidget::onImagerResolutionChanged(double *res)
/tmp/SlicerRt/DrrImageComputation/qSlicerDrrImageComputationModuleWidget.h:62: warning: The following parameter of qSlicerDrrImageComputationModuleWidget::onImagerResolutionChanged(double *res) is not documented:
  parameter 'res'
/tmp/SlicerRt/DoseVolumeHistogram/SubjectHierarchyPlugins/qSlicerSubjectHierarchyDoseVolumeHistogramPlugin.h:46: warning: argument 'item' of command @param is not found in the argument list of qSlicerSubjectHierarchyDoseVolumeHistogramPlugin::canOwnSubjectHierarchyItem(vtkIdType itemID) const
/tmp/SlicerRt/DoseVolumeHistogram/SubjectHierarchyPlugins/qSlicerSubjectHierarchyDoseVolumeHistogramPlugin.h:52: warning: The following parameter of qSlicerSubjectHierarchyDoseVolumeHistogramPlugin::canOwnSubjectHierarchyItem(vtkIdType itemID) const is not documented:
  parameter 'itemID'
/tmp/SlicerRt/DoseComparison/SubjectHierarchyPlugins/qSlicerSubjectHierarchyGammaPlugin.h:45: warning: argument 'item' of command @param is not found in the argument list of qSlicerSubjectHierarchyGammaPlugin::canOwnSubjectHierarchyItem(vtkIdType itemID) const
/tmp/SlicerRt/DoseComparison/SubjectHierarchyPlugins/qSlicerSubjectHierarchyGammaPlugin.h:51: warning: The following parameter of qSlicerSubjectHierarchyGammaPlugin::canOwnSubjectHierarchyItem(vtkIdType itemID) const is not documented:
  parameter 'itemID'
/tmp/SlicerRt/Isodose/SubjectHierarchyPlugins/qSlicerSubjectHierarchyIsodosePlugin.h:45: warning: argument 'item' of command @param is not found in the argument list of qSlicerSubjectHierarchyIsodosePlugin::canOwnSubjectHierarchyItem(vtkIdType itemID) const
/tmp/SlicerRt/Isodose/SubjectHierarchyPlugins/qSlicerSubjectHierarchyIsodosePlugin.h:51: warning: The following parameter of qSlicerSubjectHierarchyIsodosePlugin::canOwnSubjectHierarchyItem(vtkIdType itemID) const is not documented:
  parameter 'itemID'
/tmp/SlicerRt/Isodose/SubjectHierarchyPlugins/qSlicerSubjectHierarchyIsodosePlugin.h:74: warning: The following parameter of qSlicerSubjectHierarchyIsodosePlugin::getDisplayColor(vtkIdType itemID, QMap< int, QVariant > &terminologyMetaData) const is not documented:
  parameter 'itemID'
/tmp/SlicerRt/Isodose/SubjectHierarchyPlugins/qSlicerSubjectHierarchyIsodosePlugin.h:70: warning: The following parameter of qSlicerSubjectHierarchyIsodosePlugin::setDisplayColor(vtkIdType itemID, QColor color, QMap< int, QVariant > terminologyMetaData) is not documented:
  parameter 'itemID'
/tmp/SlicerRt/Beams/SubjectHierarchyPlugins/qSlicerSubjectHierarchyRTBeamPlugin.h:56: warning: argument 'item' of command @param is not found in the argument list of qSlicerSubjectHierarchyRTBeamPlugin::canOwnSubjectHierarchyItem(vtkIdType itemID) const
/tmp/SlicerRt/Beams/SubjectHierarchyPlugins/qSlicerSubjectHierarchyRTBeamPlugin.h:62: warning: The following parameter of qSlicerSubjectHierarchyRTBeamPlugin::canOwnSubjectHierarchyItem(vtkIdType itemID) const is not documented:
  parameter 'itemID'
/tmp/SlicerRt/DicomRtImportExport/SubjectHierarchyPlugins/qSlicerSubjectHierarchyRtDoseVolumePlugin.h:56: warning: argument 'item' of command @param is not found in the argument list of qSlicerSubjectHierarchyRtDoseVolumePlugin::canOwnSubjectHierarchyItem(vtkIdType itemID) const
/tmp/SlicerRt/DicomRtImportExport/SubjectHierarchyPlugins/qSlicerSubjectHierarchyRtDoseVolumePlugin.h:62: warning: The following parameter of qSlicerSubjectHierarchyRtDoseVolumePlugin::canOwnSubjectHierarchyItem(vtkIdType itemID) const is not documented:
  parameter 'itemID'
/tmp/SlicerRt/DicomRtImportExport/SubjectHierarchyPlugins/qSlicerSubjectHierarchyRtImagePlugin.h:45: warning: argument 'item' of command @param is not found in the argument list of qSlicerSubjectHierarchyRtImagePlugin::canOwnSubjectHierarchyItem(vtkIdType itemID) const
/tmp/SlicerRt/DicomRtImportExport/SubjectHierarchyPlugins/qSlicerSubjectHierarchyRtImagePlugin.h:51: warning: The following parameter of qSlicerSubjectHierarchyRtImagePlugin::canOwnSubjectHierarchyItem(vtkIdType itemID) const is not documented:
  parameter 'itemID'
/tmp/SlicerRt/Beams/SubjectHierarchyPlugins/qSlicerSubjectHierarchyRTPlanPlugin.h:49: warning: argument 'item' of command @param is not found in the argument list of qSlicerSubjectHierarchyRTPlanPlugin::canOwnSubjectHierarchyItem(vtkIdType itemID) const
/tmp/SlicerRt/Beams/SubjectHierarchyPlugins/qSlicerSubjectHierarchyRTPlanPlugin.h:55: warning: The following parameter of qSlicerSubjectHierarchyRTPlanPlugin::canOwnSubjectHierarchyItem(vtkIdType itemID) const is not documented:
  parameter 'itemID'
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:191: warning: argument 'The' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::CreateEndCapContour(vtkPolyData *inputROIPoints, vtkLine *inputLine, vtkCellArray *outputLines, double lineSpacing)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:196: warning: The following parameter of vtkPlanarContourToClosedSurfaceConversionRule::CreateEndCapContour(vtkPolyData *inputROIPoints, vtkLine *inputLine, vtkCellArray *outputLines, double lineSpacing) is not documented:
  parameter 'lineSpacing'
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:199: warning: argument 'The' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::CreateSmoothEndCapContour(vtkPolyData *inputROIPoints, vtkLine *inputLine, vtkCellArray *outputLines, double lineSpacing)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:204: warning: The following parameter of vtkPlanarContourToClosedSurfaceConversionRule::CreateSmoothEndCapContour(vtkPolyData *inputROIPoints, vtkLine *inputLine, vtkCellArray *outputLines, double lineSpacing) is not documented:
  parameter 'lineSpacing'
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:207: warning: argument 'The' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::CreateStraightEndCapContour(vtkPolyData *inputROIPoints, vtkLine *inputLine, vtkCellArray *outputLines, double lineSpacing)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:212: warning: The following parameter of vtkPlanarContourToClosedSurfaceConversionRule::CreateStraightEndCapContour(vtkPolyData *inputROIPoints, vtkLine *inputLine, vtkCellArray *outputLines, double lineSpacing) is not documented:
  parameter 'lineSpacing'
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:234: warning: argument 'inputLines' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::DecimateLines(vtkPolyData *inputPolyData, double decimationFactor)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:238: warning: The following parameter of vtkPlanarContourToClosedSurfaceConversionRule::DecimateLines(vtkPolyData *inputPolyData, double decimationFactor) is not documented:
  parameter 'inputPolyData'
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:154: warning: argument 'The' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::DoLinesOverlap(vtkLine *line1, vtkLine *line2)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:154: warning: argument 'The' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::DoLinesOverlap(vtkLine *line1, vtkLine *line2)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:156: warning: The following parameters of vtkPlanarContourToClosedSurfaceConversionRule::DoLinesOverlap(vtkLine *line1, vtkLine *line2) are not documented:
  parameter 'line1'
  parameter 'line2'
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:177: warning: argument 'inputLines' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::EndCapping(vtkPolyData *inputROIPoints, vtkCellArray *outputPolygons, std::vector< bool > lineTriganulatedToAbove, std::vector< bool > lineTriganulatedToBelow)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:127: warning: argument 'The' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::FixKeyholes(vtkPolyData *inputROIPoints, double epsilon, int minimumSeperation)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:127: warning: argument 'The' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::FixKeyholes(vtkPolyData *inputROIPoints, double epsilon, int minimumSeperation)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:130: warning: The following parameters of vtkPlanarContourToClosedSurfaceConversionRule::FixKeyholes(vtkPolyData *inputROIPoints, double epsilon, int minimumSeperation) are not documented:
  parameter 'epsilon'
  parameter 'minimumSeperation'
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:261: warning: argument 'inputLine' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::FixLines(vtkPolyData *inputLines, vtkPolyData *outputLines)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:261: warning: argument 'outputLine' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::FixLines(vtkPolyData *inputLines, vtkPolyData *outputLines)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:266: warning: The following parameters of vtkPlanarContourToClosedSurfaceConversionRule::FixLines(vtkPolyData *inputLines, vtkPolyData *outputLines) are not documented:
  parameter 'inputLines'
  parameter 'outputLines'
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:221: warning: argument 'The' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::GetNextLocation(vtkIdType currentLocation, int numberOfPoints, bool loopClosed)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:221: warning: argument 'The' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::GetNextLocation(vtkIdType currentLocation, int numberOfPoints, bool loopClosed)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:221: warning: argument 'Whether' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::GetNextLocation(vtkIdType currentLocation, int numberOfPoints, bool loopClosed)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:225: warning: The following parameters of vtkPlanarContourToClosedSurfaceConversionRule::GetNextLocation(vtkIdType currentLocation, int numberOfPoints, bool loopClosed) are not documented:
  parameter 'currentLocation'
  parameter 'numberOfPoints'
  parameter 'loopClosed'
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:228: warning: argument 'The' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::GetPreviousLocation(vtkIdType currentLocation, int numberOfPoints, bool loopClosed)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:228: warning: argument 'The' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::GetPreviousLocation(vtkIdType currentLocation, int numberOfPoints, bool loopClosed)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:228: warning: argument 'Whether' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::GetPreviousLocation(vtkIdType currentLocation, int numberOfPoints, bool loopClosed)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:232: warning: The following parameters of vtkPlanarContourToClosedSurfaceConversionRule::GetPreviousLocation(vtkIdType currentLocation, int numberOfPoints, bool loopClosed) are not documented:
  parameter 'currentLocation'
  parameter 'numberOfPoints'
  parameter 'loopClosed'
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:102: warning: argument 'Cell' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::TriangulateBetweenContours(vtkPolyData *inputROIPoints, vtkIdList *pointsInLine1, vtkIdList *pointsInLine2, vtkCellArray *outputPolygons)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:106: warning: The following parameter of vtkPlanarContourToClosedSurfaceConversionRule::TriangulateBetweenContours(vtkPolyData *inputROIPoints, vtkIdList *pointsInLine1, vtkIdList *pointsInLine2, vtkCellArray *outputPolygons) is not documented:
  parameter 'outputPolygons'
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:215: warning: argument 'Contour' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::TriangulateContourInterior(vtkLine *inputLine, vtkCellArray *outputPolys, bool normalsUp)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:215: warning: argument 'Cell' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::TriangulateContourInterior(vtkLine *inputLine, vtkCellArray *outputPolys, bool normalsUp)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:215: warning: argument 'True' of command @param is not found in the argument list of vtkPlanarContourToClosedSurfaceConversionRule::TriangulateContourInterior(vtkLine *inputLine, vtkCellArray *outputPolys, bool normalsUp)
/tmp/SlicerRt/DicomRtImportExport/ConversionRules/vtkPlanarContourToClosedSurfaceConversionRule.h:218: warning: The following parameters of vtkPlanarContourToClosedSurfaceConversionRule::TriangulateContourInterior(vtkLine *inputLine, vtkCellArray *outputPolys, bool normalsUp) are not documented:
  parameter 'inputLine'
  parameter 'outputPolys'
  parameter 'normalsUp'
/tmp/SlicerRt/DicomRtImportExport/Logic/vtkSlicerDicomRtImportExportModuleLogic.cxx:225: warning: The following parameter of vtkSlicerDicomRtImportExportModuleLogic::vtkInternal::CalculateSliceSpacing(vtkSlicerDicomRtReader *rtReader, const char *roiReferencedSeriesUid) is not documented:
  parameter 'rtReader'
/tmp/SlicerRt/DicomRtImportExport/Logic/vtkSlicerDicomRtReader.h:131: warning: The following parameters of vtkSlicerDicomRtReader::GetBeamControlPointJawPositions(unsigned int beamNumber, unsigned int controlPoint, double jawPositions[2][2]) are not documented:
  parameter 'beamNumber'
  parameter 'controlPoint'
/tmp/SlicerRt/DicomRtImportExport/Logic/vtkSlicerDicomRtReader.h:174: warning: The following parameters of vtkSlicerDicomRtReader::GetBeamControlPointMultiLeafCollimatorPositions(unsigned int beamNumber, unsigned int controlPoint, std::vector< double > &pairBoundaries, std::vector< double > &leafPositions) are not documented:
  parameter 'beamNumber'
  parameter 'controlPoint'
/tmp/SlicerRt/DicomRtImportExport/Logic/vtkSlicerDicomRtReader.h:146: warning: The following parameters of vtkSlicerDicomRtReader::GetBeamControlPointScanningSpotSize(unsigned int beamNumber, unsigned int controlPointIndex, std::array< float, 2 > &ScanSpotSize) are not documented:
  parameter 'beamNumber'
  parameter 'controlPointIndex'
/tmp/SlicerRt/DicomRtImportExport/Logic/vtkSlicerDicomRtReader.h:139: warning: The following parameters of vtkSlicerDicomRtReader::GetBeamControlPointScanSpotParameters(unsigned int beamNumber, unsigned int controlPointIndex, std::vector< float > &positionMap, std::vector< float > &metersetWeights) are not documented:
  parameter 'beamNumber'
  parameter 'controlPointIndex'
/tmp/SlicerRt/DoseVolumeHistogram/Logic/vtkSlicerDoseVolumeHistogramModuleLogic.h:122: warning: The following parameter of vtkSlicerDoseVolumeHistogramModuleLogic::AssembleDoseMetricName(vtkMRMLScalarVolumeNode *doseVolumeNode, std::string doseMetricAttributeNamePrefix) is not documented:
  parameter 'doseVolumeNode'
/tmp/SlicerRt/DoseVolumeHistogram/Logic/vtkSlicerDoseVolumeHistogramModuleLogic.h:111: warning: The following parameters of vtkSlicerDoseVolumeHistogramModuleLogic::ExportDvhToCsv(vtkMRMLDoseVolumeHistogramNode *parameterNode, const char *fileName, bool comma=true) are not documented:
  parameter 'parameterNode'
  parameter 'fileName'
/tmp/SlicerRt/DosxyzNrc3dDoseFileReader/Logic/vtkSlicerDosxyzNrc3dDoseFileReaderLogic.h:51: warning: The following parameter of vtkSlicerDosxyzNrc3dDoseFileReaderLogic::LoadDosxyzNrc3dDoseFile(char *filename, float intensityScalingFactor=1e+18) is not documented:
  parameter 'intensityScalingFactor'
/tmp/SlicerRt/DrrImageComputation/Logic/vtkSlicerDrrImageComputationLogic.h:119: warning: argument 'mat' of command @param is not found in the argument list of vtkSlicerDrrImageComputationLogic::GetPointOffsetFromImagerOrigin(vtkMRMLDrrImageComputationNode *parameterNode, const double pointRAS[3], double offsetWidthHeight[2], double offsetColumnRow[2])
/tmp/SlicerRt/DrrImageComputation/Logic/vtkSlicerDrrImageComputationLogic.h:123: warning: The following parameters of vtkSlicerDrrImageComputationLogic::GetPointOffsetFromImagerOrigin(vtkMRMLDrrImageComputationNode *parameterNode, const double pointRAS[3], double offsetWidthHeight[2], double offsetColumnRow[2]) are not documented:
  parameter 'pointRAS'
  parameter 'offsetWidthHeight'
  parameter 'offsetColumnRow'
/tmp/SlicerRt/DrrImageComputation/Logic/vtkSlicerDrrImageComputationLogic.h:126: warning: argument 'point' of command @param is not found in the argument list of vtkSlicerDrrImageComputationLogic::GetRayIntersectWithImagerPlane(vtkMRMLDrrImageComputationNode *parameterNode, const double pointRAS[3], double pointIntersectRAS[3])
/tmp/SlicerRt/DrrImageComputation/Logic/vtkSlicerDrrImageComputationLogic.h:126: warning: argument 'pointIntersect' of command @param is not found in the argument list of vtkSlicerDrrImageComputationLogic::GetRayIntersectWithImagerPlane(vtkMRMLDrrImageComputationNode *parameterNode, const double pointRAS[3], double pointIntersectRAS[3])
/tmp/SlicerRt/DrrImageComputation/Logic/vtkSlicerDrrImageComputationLogic.h:133: warning: The following parameters of vtkSlicerDrrImageComputationLogic::GetRayIntersectWithImagerPlane(vtkMRMLDrrImageComputationNode *parameterNode, const double pointRAS[3], double pointIntersectRAS[3]) are not documented:
  parameter 'pointRAS'
  parameter 'pointIntersectRAS'
/tmp/SlicerRt/Beams/Logic/vtkSlicerMLCPositionLogic.h:138: warning: The following parameter of vtkSlicerMLCPositionLogic::CalculateCurveBoundary(vtkMRMLMarkupsCurveNode *node, double curveBound[4]) is not documented:
  parameter 'node'
/tmp/SlicerRt/Beams/Logic/vtkSlicerMLCPositionLogic.h:142: warning: The following parameters of vtkSlicerMLCPositionLogic::FindLeafPairRangeIndexes(double curveBound[4], vtkTable *mlcTable, int &leafPairIndexFirst, int &leafPairIndexLast) are not documented:
  parameter 'mlcTable'
  parameter 'leafPairIndexFirst'
  parameter 'leafPairIndexLast'
/tmp/SlicerRt/Beams/Logic/vtkSlicerMLCPositionLogic.h:145: warning: argument 'curveBound' of command @param is not found in the argument list of vtkSlicerMLCPositionLogic::FindLeafPairRangeIndexes(vtkMRMLRTBeamNode *beamNode, vtkMRMLTableNode *mlcTableNode, int &leafPairIndexFirst, int &leafPairIndexLast)
/tmp/SlicerRt/Beams/Logic/vtkSlicerMLCPositionLogic.h:147: warning: The following parameters of vtkSlicerMLCPositionLogic::FindLeafPairRangeIndexes(vtkMRMLRTBeamNode *beamNode, vtkMRMLTableNode *mlcTableNode, int &leafPairIndexFirst, int &leafPairIndexLast) are not documented:
  parameter 'beamNode'
  parameter 'mlcTableNode'
  parameter 'leafPairIndexFirst'
  parameter 'leafPairIndexLast'
/tmp/SlicerRt/Beams/Logic/vtkSlicerMLCPositionLogic.h:75: warning: The following parameter of vtkSlicerMLCPositionLogic::UpdateMultiLeafCollimatorTableNodeBoundaryData(vtkMRMLTableNode *mlcTable, bool mlcType, unsigned int nofLeafPairs, double leafPairSize, double isocenterOffset=0.0) is not documented:
  parameter 'mlcTable'
/tmp/SlicerRt/PinnacleDvfReader/Logic/vtkSlicerPinnacleDvfReaderLogic.h:43: warning: argument 'br' of command @param is not found in the argument list of vtkSlicerPinnacleDvfReaderLogic::LoadPinnacleDvf(char *filename, double gridOriginX, double gridOriginY, double gridOriginZ)
/tmp/SlicerRt/PinnacleDvfReader/Logic/vtkSlicerPinnacleDvfReaderLogic.h:46: warning: The following parameters of vtkSlicerPinnacleDvfReaderLogic::LoadPinnacleDvf(char *filename, double gridOriginX, double gridOriginY, double gridOriginZ) are not documented:
  parameter 'gridOriginX'
  parameter 'gridOriginY'
  parameter 'gridOriginZ'
/tmp/SlicerRt/RoomsEyeView/Logic/vtkSlicerRoomsEyeViewModuleLogic.h:135: warning: The following parameter of vtkSlicerRoomsEyeViewModuleLogic::GetFileToRASTransformMatrixForPartType(std::string partType, vtkMatrix4x4 *fileToPartTransformMatrix) is not documented:
  parameter 'partType'
/tmp/SlicerRt/RoomsEyeView/Logic/vtkSlicerRoomsEyeViewModuleLogic.h:89: warning: The following parameter of vtkSlicerRoomsEyeViewModuleLogic::SetupTreatmentMachineModels(vtkMRMLRoomsEyeViewNode *parameterNode, bool forceEnableCollisionDetection=false) is not documented:
  parameter 'parameterNode'
/tmp/SlicerRt/SlicerRtCommon/vtkSlicerRtCommon.h:173: warning: argument 'outItkVolume' of command @param is not found in the argument list of vtkSlicerRtCommon::ConvertVolumeNodeToItkImage(vtkMRMLScalarVolumeNode *inVolumeNode, typename itk::Image< T, 3 >::Pointer outItkImage, bool applyRasToWorldConversion=true, bool applyRasToLpsConversion=true)
/tmp/SlicerRt/SlicerRtCommon/vtkSlicerRtCommon.h:180: warning: The following parameter of vtkSlicerRtCommon::ConvertVolumeNodeToItkImage(vtkMRMLScalarVolumeNode *inVolumeNode, typename itk::Image< T, 3 >::Pointer outItkImage, bool applyRasToWorldConversion=true, bool applyRasToLpsConversion=true) is not documented:
  parameter 'outItkImage'
/tmp/SlicerRt/SlicerRtCommon/vtkSlicerRtCommon.h:183: warning: argument 'outItkVolume' of command @param is not found in the argument list of vtkSlicerRtCommon::ConvertVtkOrientedImageDataToItkImage(vtkOrientedImageData *inImageData, typename itk::Image< T, 3 >::Pointer outItkImage, bool applyRasToLpsConversion=true)
/tmp/SlicerRt/SlicerRtCommon/vtkSlicerRtCommon.h:189: warning: The following parameter of vtkSlicerRtCommon::ConvertVtkOrientedImageDataToItkImage(vtkOrientedImageData *inImageData, typename itk::Image< T, 3 >::Pointer outItkImage, bool applyRasToLpsConversion=true) is not documented:
  parameter 'outItkImage'
/tmp/SlicerRt/SlicerRtCommon/vtkSlicerRtCommon.h:151: warning: The following parameter of vtkSlicerRtCommon::GenerateRandomColor(vtkMRMLColorTableNode *colorNode, double *newColor) is not documented:
  parameter 'newColor'

@cpinter
Copy link
Member

cpinter commented Jan 20, 2025

Wow, this is excellent @ferdymercury ! Thank you very much for the contribution! I'll merge this now and we can discuss some details later if needed. I think we can host the documentation if we come up with a good system.

@cpinter cpinter merged commit 169eed7 into SlicerRt:master Jan 20, 2025
@ferdymercury ferdymercury deleted the patch-1 branch January 20, 2025 10:34
@ferdymercury
Copy link
Contributor Author

I'll merge this now and we can discuss some details later if needed.

Thanks, sure!

I think we can host the documentation if we come up with a good system.

See ideas on how to automatize that using GH actions and/or AWS: https://github.com/root-project/root/blob/master/.github/workflows/root-docs-ci.yml#L138

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Doxygen documentation for SlicerRT source code
2 participants