Help,
I am really scratching my head over the indentation in the following
piece of code.
If have tried dots, par commands, blank lines. Everything I could think
of. But the functions after the list in the @name block come out wrongly
indented. The first two functions (EnumerateMathPlugins and
SelectMathPlugin) come out two (approx) indents (I am using spaces)
further to the left than the last sub list entry (The current selected
math plugin..) and the next function is not indented at all!
You can verify this by saving this code as test.h and running doxygen
test.h (no config file). I think my doxygen version is 1.8.4 (Ubuntu 13.10).
All help gratefully received.
Roger
#include <vector>
#include <string>
/*!
* \class AlignmentSubsystem
* \brief Provides functions to manage the loading and initialisation of
Alignment Subsystem plugin database and math modules. Also provides
* helper functions for telescope drivers using the the Alignment Subsystem.
*
* TODO see if we can detect if this class is being used by a client or a
driver from RTTI
* so that we can access INDI properties appropriately
*
* \note It is intended that this class should be included as a base class
alongside INDI::Telescope in derived
* telescope driver classes. In the same way the INDI::GuiderInterface class is
used.
*/
class AlignmentSubsystem
{
public:
/*! @name Plugin management
* These functions are used to enumerate, load, and utilise math plugins.
* They are intended to be used solely in driver modules.
* The following INDI properties are used to communicate the plugin
details to the client if required.
* - ALIGNMENT_SUBSYSTEM_MATH_PLUGINS\n
* A list of available plugins (switch)
* - ALIGNMENT_SUBSYSYSTEM_CURRENT_MATH_PLUGIN\n
* The current selected math plugin. Read/write if required (text)
* .
*
*/
///@{
/*!
* \brief Return a list of the names of the available math plugins.
* \param[out] MathPlugins Reference to a list of the names of the
available math plugins.
* \return False on failure
*/
bool EnumerateMathPlugins(const std::vector<std::string>& MathPlugins);
/*!
* \brief Selects, loads and initialises the named math plugin.
* \param[in] MathPluginName The name of the required math plugin.
* \return False on failure.
*/
bool SelectMathPlugin(const std::string& MathPluginName);
/*!
* \brief Get a pointer to the current math plugin.
* \return NULL on failure.
*/
const MathPlugin* GetMathPluginPointer(void);
///@}
};
------------------------------------------------------------------------------
Shape the Mobile Experience: Free Subscription
Software experts and developers: Be at the forefront of tech innovation.
Intel(R) Software Adrenaline delivers strategic insight and game-changing
conversations that shape the rapidly evolving mobile landscape. Sign up now.
http://pubads.g.doubleclick.net/gampad/clk?id=63431311&iu=/4140/ostg.clktrk
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
