Re: [Doxygen-users] c++ doxygen warnings re params

[Albert <alb...@gm...>]

Michele,

Adding the variable names to the definition in the .h file removes the
warning.
I would also advise to upgrade to the current version (1.8.9.1) as 1.7.3 is
a bit old (2011).

Albert

On Fri, May 1, 2015 at 6:35 PM, Michele Joyce <er...@jl...> wrote:

>  I'm using doxygen version 1.7.3 on rhel-6-ia32
>
> * spikeScreen.h*
>
> #ifndef SPIKESCREEN_H
> #define SPIKESCREEN_H
>
> /*! \file spikeScreen.h
>  * \brief Define the SpikeScreen widget class
>  * \author A. Carpenter
>  */
>
> #include <bpmSource.h>
>
> /*! \brief Define the SpikeScreen widget class.
>  */
> class SpikeScreen
> {
>   public:
>     SpikeScreen(const char *,
>       const std::vector <const JData::Bpm::BpmSource::Element *> &,
>       const std::string &, const int, const int );
> };
> #endif
>
> *spikeScreen.cpp *
>
> /*! \brief Create a BPM Spike Screen
>  * \details These are the screens that Operations uses to visualize the
> beam
>  * position.
> * * \param screenname - The name of the resulting screen file*
>  * \param elems The vector of BPM elements to display
>  * \param title A string that is appended to the title bar title
>  * \param x Horizontal location of screen in pixels
>  * \param y Vertical location of screen in pixels
> */
> SpikeScreen::SpikeScreen(*const char *screenname*,
>   const std::vector<const BpmSource::Element *> &elems,
>   const std::string &title, const int x, const int y) :
>   EDL::Panel(new EDL::ColumnLayout(5,5)), m_name(screenname)
> {}
>
> *doxygen warning *
>
> [468] erb@subopsl05 > cd ../doc;doxygen
> */a/dvlcsue/dvlhome/apps/b/bpmspikes/dvl/src/spikeScreen.cpp:24 warning:
> argument 'screenname' of command @param is not found in the argument list
> of SpikeScreen::SpikeScreen(const char *, const std::vector< const
> JData::Bpm::BpmSource::Element * > &, const std::string &, const int, const
> int)*
> /a/dvlcsue/dvlhome/apps/b/bpmspikes/dvl/src/spikeScreen.cpp:24 warning:
> argument 'elems' of command @param is not found in the argument list of
> SpikeScreen::SpikeScreen(const char *, const std::vector< const
> JData::Bpm::BpmSource::Element * > &, const std::string &, const int, const
> int)
> /a/dvlcsue/dvlhome/apps/b/bpmspikes/dvl/src/spikeScreen.cpp:24 warning:
> argument 'title' of command @param is not found in the argument list of
> SpikeScreen::SpikeScreen(const char *, const std::vector< const
> JData::Bpm::BpmSource::Element * > &, const std::string &, const int, const
> int)
> /a/dvlcsue/dvlhome/apps/b/bpmspikes/dvl/src/spikeScreen.cpp:24 warning:
> argument 'x' of command @param is not found in the argument list of
> SpikeScreen::SpikeScreen(const char *, const std::vector< const
> JData::Bpm::BpmSource::Element * > &, const std::string &, const int, const
> int)
> /a/dvlcsue/dvlhome/apps/b/bpmspikes/dvl/src/spikeScreen.cpp:24 warning:
> argument 'y' of command @param is not found in the argument list of
> SpikeScreen::SpikeScreen(const char *, const std::vector< const
> JData::Bpm::BpmSource::Element * > &, const std::string &, const int, const
> int)
>
> *As you can see, doxygen insists that the parameters that I've defined are
> not found in the argument list...when they actually do.*
> Removing the \param definitions completely gives no warnings....
>
> Any and all help is appreciated.
> Michele
>
>
>
>
> ------------------------------------------------------------------------------
> One dashboard for servers and applications across Physical-Virtual-Cloud
> Widest out-of-the-box monitoring support with 50+ applications
> Performance metrics, stats and reports that give you Actionable Insights
> Deep dive visibility with transaction tracing using APM Insight.
> http://ad.doubleclick.net/ddm/clk/290420510;117567292;y
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>