Various doxygen improvements/fixes.

This commit is contained in:
Thomas Geymayer 2018-01-12 08:31:07 +01:00
parent 19cc797c41
commit b989f4085d
5 changed files with 24 additions and 18 deletions

View File

@ -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.

View File

@ -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<typename StringType>
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<typename StringType>
inline SGPropertyNode*
makeNode(SGPropertyNode* parent, const StringType& name)
{
return parent->getNode(name, true);
}
}
// For boost::hash

View File

@ -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 <simgear/structure/Singleton.hxx>
#include "Effect.hxx"
/**
* Support classes for parsing effects.
*/
namespace simgear
{

View File

@ -36,10 +36,9 @@
#include <simgear/structure/exception.hxx>
#include <simgear/structure/Singleton.hxx>
/// Expression tree implementation.
namespace simgear
{
/// Expression tree implementation.
namespace expression
{
enum Type {

View File

@ -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 Ret, class... Args>
class function_list<Ret(Args...)>: