Skip to content

Doxygen errors #29

@sherm1

Description

@sherm1

I just built my shiny new GitHub version of opensim-core. Then I built doxygen (on Windows, using doxygen 1.8.7). Doxygen ran but had several groups of complaints, attached below. These should be fixed so that doxygen runs without errors.

OpenSim/Common/Property_Deprecated.h:70: warning: Found unknown command `\tbool'
OpenSim/Common/Property_Deprecated.h:72: warning: Found unknown command `\tint'
(and a bunch more like that)

and

OpenSim/Common/PolynomialFunction.h:83: warning: argument 'Vector' of command @param is not found in the argument list of OpenSim::PolynomialFunction::setCoefficients(SimTK::Vector coefficients)
OpenSim/Common/PolynomialFunction.h:83: warning: The following parameters of OpenSim::PolynomialFunction::setCoefficients(SimTK::Vector coefficients) are not documented:
2>    parameter 'coefficients'
OpenSim/Common/SmoothSegmentedFunction.h:410: warning: The following parameters of OpenSim::SmoothSegmentedFunction::printMatrixToFile(SimTK::Matrix &data, SimTK::Array_< std::string > &colnames, const std::string &path, const std::string &filename) const are not documented:
2>    parameter 'colnames'
OpenSim/Analyses/StaticOptimizationTarget.h:56: warning: End of list marker found without any preceding list items

and

OpenSim/Common/Component.h:399: warning: argument 'state' of command @param is not found in the argument list of OpenSim::Component::getOutput(const std::string &name) const
OpenSim/Common/ComponentOutput.h:110: warning: argument 'outputMethod' of command @param is not found in the argument list of OpenSim::Output< T >::Output(const std::string &name, const std::function< T(const SimTK::State &)> outputFunction, const SimTK::Stage &dependsOnStage)
OpenSim/Common/ComponentOutput.h:110: warning: The following parameters of OpenSim::Output::Output(const std::string &name, const std::function< T(const SimTK::State &)> outputFunction, const SimTK::Stage &dependsOnStage) are not documented:
2>    parameter 'name'
2>    parameter 'outputFunction'
2>  C:/Users/Sherm/Documents/GitHub/opensim-org/opensim-core/OpenSim/Common/PolynomialFunction.h:83: warning: argument 'Vector' of command @param is not found in the argument list of OpenSim::PolynomialFunction::setCoefficients(SimTK::Vector coefficients)
OpenSim/Common/PolynomialFunction.h:83: warning: The following parameters of OpenSim::PolynomialFunction::setCoefficients(SimTK::Vector coefficients) are not documented:
2>    parameter 'coefficients'
2>  C:/Users/Sherm/Documents/GitHub/opensim-org/opensim-core/OpenSim/Common/Component.h:399: warning: argument 'state' of command @param is not found in the argument list of OpenSim::Component::getOutput(const std::string &name) const
2>  C:/Users/Sherm/Documents/GitHub/opensim-org/opensim-core/OpenSim/Common/ComponentOutput.h:110: warning: argument 'outputMethod' of command @param is not found in the argument list of OpenSim::Output< T >::Output(const std::string &name, const std::function< T(const SimTK::State &)> outputFunction, const SimTK::Stage &dependsOnStage)
OpenSim/Common/ComponentOutput.h:110: warning: The following parameters of OpenSim::Output::Output(const std::string &name, const std::function< T(const SimTK::State &)> outputFunction, const SimTK::Stage &dependsOnStage) are not documented:
2>    parameter 'name'
2>    parameter 'outputFunction'

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions