From b989f4085df6205c556e2466a47bd72d817b76d3 Mon Sep 17 00:00:00 2001 From: Thomas Geymayer Date: Fri, 12 Jan 2018 08:31:07 +0100 Subject: [PATCH] Various doxygen improvements/fixes. --- DoxygenMain.cxx | 4 ++++ simgear/props/props.hxx | 26 +++++++++++++----------- simgear/scene/material/EffectBuilder.hxx | 6 +++--- simgear/structure/SGExpression.hxx | 3 +-- simgear/structure/function_list.hxx | 3 ++- 5 files changed, 24 insertions(+), 18 deletions(-) diff --git a/DoxygenMain.cxx b/DoxygenMain.cxx index 592e9409..8ad79316 100644 --- a/DoxygenMain.cxx +++ b/DoxygenMain.cxx @@ -2,6 +2,10 @@ documentation. It has a .cxx extension so that emacs will happily autoindent correctly. */ +/** + * \namespace simgear + * \brief \ref index "SimGear" main namespace. + */ /** \mainpage SimGear * Simulation, Visualization, and Game development libraries. diff --git a/simgear/props/props.hxx b/simgear/props/props.hxx index 1f56e80e..4c2bb242 100644 --- a/simgear/props/props.hxx +++ b/simgear/props/props.hxx @@ -99,9 +99,9 @@ inline T parseString(const std::string& str) return result; } -/** - * Property value types. - */ +// +// Property value types +// #ifdef NONE #pragma warn A sloppy coder has defined NONE as a macro! @@ -148,6 +148,7 @@ inline T parseString(const std::string& str) #undef STRING #endif +/// Property system which associates property names with values. namespace props { /** @@ -2144,17 +2145,18 @@ inline SGPropertyNode* makeChild(SGPropertyNode* parent, const char* name, return parent->getChild(name, index, true); } -/** - * Utility function for creation of a child property node using a - * relative path. - */ namespace simgear { -template -inline SGPropertyNode* makeNode(SGPropertyNode* parent, const StringType& name) -{ - return parent->getNode(name, true); -} + /** + * Utility function for creation of a child property node using a + * relative path. + */ + template + inline SGPropertyNode* + makeNode(SGPropertyNode* parent, const StringType& name) + { + return parent->getNode(name, true); + } } // For boost::hash diff --git a/simgear/scene/material/EffectBuilder.hxx b/simgear/scene/material/EffectBuilder.hxx index 84003109..c3aec49c 100644 --- a/simgear/scene/material/EffectBuilder.hxx +++ b/simgear/scene/material/EffectBuilder.hxx @@ -1,3 +1,6 @@ +///@file +/// Support classes for parsing effects. +/// // Copyright (C) 2009 Tim Moore timoore@redhat.com // // This library is free software; you can redistribute it and/or @@ -39,9 +42,6 @@ #include #include "Effect.hxx" -/** - * Support classes for parsing effects. - */ namespace simgear { diff --git a/simgear/structure/SGExpression.hxx b/simgear/structure/SGExpression.hxx index 2cfa3dc8..bbe9c037 100644 --- a/simgear/structure/SGExpression.hxx +++ b/simgear/structure/SGExpression.hxx @@ -36,10 +36,9 @@ #include #include -/// Expression tree implementation. - namespace simgear { + /// Expression tree implementation. namespace expression { enum Type { diff --git a/simgear/structure/function_list.hxx b/simgear/structure/function_list.hxx index 89347636..da9933d6 100644 --- a/simgear/structure/function_list.hxx +++ b/simgear/structure/function_list.hxx @@ -29,7 +29,8 @@ namespace simgear /** * Handle a list of callbacks like a single boost::function. * - * @tparam Sig Function signature. + * @tparam Ret Return type of the callbacks + * @tparam Args Parameter types of the callbacks */ template class function_list: