doxygen-users — List for users of doxygen

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

[Michele J. <er...@jl...>]

OK. But I still wonder why this is happening...
I've been using the same doxyfile with  param definitions  for many many 
projects, and I've never before had this issue...

Thanks for the tip regarding the version. I will ask our system admin 
folks to update it.
Michele

On 05/01/2015 12:46 PM, Albert wrote:
> 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... 
> <mailto: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...
>     <mailto:Dox...@li...>
>     https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

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

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

[Michele J. <er...@jl...>]

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

Re: [Doxygen-users] Doxygen-non Ascii characters

[Pascal F. <pas...@hg...>]

Hello,

I think the solution is to set the INPUT_ENCODING :

	# This tag can be used to specify the character encoding of the source files
	# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
	# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
	# documentation (see: http://www.gnu.org/software/libiconv) for the list of
	# possible encodings.
	# The default value is: UTF-8.

	INPUT_ENCODING         = ISO-8859-1

Regards,

Pascal


-----Message d'origine-----
De : tsm21 [mailto:ts...@gm...] 
Envoyé : jeudi 30 avril 2015 07:19
À : dox...@li...
Objet : [Doxygen-users] Doxygen-non Ascii characters

Hello,

We have some C files where those files are converted to XML files using Doxygen.

But some of the C files contain non Ascii characters (like ç, d'é, é, ä, µ).
So when these XML files are transformed by xslt file and merge all the files in to a single xml file, errors are displayed "Invalid byte 1 of 1-byte
UTF-8 sequence." 

So is there way to solve this issue ?

 
Thankyou
Regards
Sai



--
View this message in context: http://doxygen.10944.n7.nabble.com/Doxygen-non-Ascii-characters-tp7167.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

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

[Doxygen-users] Doxygen-non Ascii characters

[tsm21 <ts...@gm...>]

Hello,

We have some C files where those files are converted to XML files using
Doxygen.

But some of the C files contain non Ascii characters (like ç, d'é, é, ä, µ).
So when these XML files are transformed by xslt file and merge all the files
in to a single xml file, errors are displayed "Invalid byte 1 of 1-byte
UTF-8 sequence." 

So is there way to solve this issue ?

 
Thankyou
Regards
Sai



--
View this message in context: http://doxygen.10944.n7.nabble.com/Doxygen-non-Ascii-characters-tp7167.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] Call the search from extern

[Florian L. <mai...@xg...>]

Hello,

I have a doxygen with the search box at the right top. This works fine but 
now I want to call my documentation and supply a search term, like 
http://google.com/#q=foobar to search for foobar.

How can I do that?

Thanks,
Florian

Re: [Doxygen-users] Browser shows nothing in the index file

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

Aketh,

Looks your system came by default with version 1.6.1 of doxygen and that
this is in your path. When installing doxygen it looks like it is not added
to the path. Please add doxygen to your path or as a first test run doxygen
with the full path when executing it.

Albert

On Tue, Apr 28, 2015 at 7:30 PM, aketh <ake...@gm...> wrote:

> It seems like, I installed 1.8.9.1(I downloaded latest one).
>
> But when i type Doxygen -V i get 1.6.1.
>
> Regards,
> Aketh T. M
>
> On 28 April 2015 at 22:29, albert [via Doxygen] <
> ml-...@n7...> wrote:
>
> > Aketh,
> >
> > You specify doxygen version 1.6.1 (which is from August 2009) and you use
> > a recent dot version. Do you get the same problems with the current
> version
> > of doxygen(1.8.9.1) and your dot version?
> >
> > Albert
> >
> > On Tue, Apr 28, 2015 at 1:59 PM, aketh <[hidden email]
> > <http:///user/SendEmail.jtp?type=node&node=7163&i=0>> wrote:
> >
> >> Hi all I installed Doxygen and graphviz tool.
> >>
> >> I am trying to create a call graph for baroclinic.F90 file of CESM.
> >>
> >> However when I run firefox index.html, I got a blank browser. through
> file
> >> tab's "open file" was blank even after, I browsed to the path of
> >> baroclinic.F90.
> >>
> >> On trying dot to open a few .dot files, I got these errors.
> >>
> >> dot graph_legend.dot
> >> There is no layout engine support for "dot"
> >> Perhaps "dot -c" needs to be run (with installer's privileges) to
> register
> >> the plugins?
> >>
> >> Can this be the issue?
> >>
> >> My version of dot is dot - graphviz version 2.38.0 (20140413.2041) and
> >> 1.6.1
> >> doxygen.
> >>
> >> thanks in advance,
> >> Aketh
> >>
> >>
> >>
> >>
> >>
> >>
> >> --
> >> View this message in context:
> >>
> http://doxygen.10944.n7.nabble.com/Browser-shows-nothing-in-the-index-file-tp7161.html
> >> Sent from the Doxygen - Users mailing list archive at Nabble.com.
> >>
> >>
> >>
> ------------------------------------------------------------------------------
> >> 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
> >> [hidden email] <http:///user/SendEmail.jtp?type=node&node=7163&i=1>
> >> https://lists.sourceforge.net/lists/listinfo/doxygen-users
> >>
> >
> >
> >
> ------------------------------------------------------------------------------
> >
> > 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
> > [hidden email] <http:///user/SendEmail.jtp?type=node&node=7163&i=2>
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
> >
> >
> > ------------------------------
> >  If you reply to this email, your message will be added to the discussion
> > below:
> >
> >
> http://doxygen.10944.n7.nabble.com/Browser-shows-nothing-in-the-index-file-tp7161p7163.html
> >  To unsubscribe from Browser shows nothing in the index file, click here
> > <
> http://doxygen.10944.n7.nabble.com/template/NamlServlet.jtp?macro=unsubscribe_by_code&node=7161&code=YWtldGgudG1AZ21haWwuY29tfDcxNjF8NzUzMjM3MDc1
> >
> > .
> > NAML
> > <
> http://doxygen.10944.n7.nabble.com/template/NamlServlet.jtp?macro=macro_viewer&id=instant_html%21nabble%3Aemail.naml&base=nabble.naml.namespaces.BasicNamespace-nabble.view.web.template.NabbleNamespace-nabble.view.web.template.NodeNamespace&breadcrumbs=notify_subscribers%21nabble%3Aemail.naml-instant_emails%21nabble%3Aemail.naml-send_instant_email%21nabble%3Aemail.naml
> >
> >
>
>
>
>
> --
> View this message in context:
> http://doxygen.10944.n7.nabble.com/Browser-shows-nothing-in-the-index-file-tp7161p7164.html
> Sent from the Doxygen - Users mailing list archive at Nabble.com.
>
>
> ------------------------------------------------------------------------------
> 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
>

Re: [Doxygen-users] Browser shows nothing in the index file

[aketh <ake...@gm...>]

It seems like, I installed 1.8.9.1(I downloaded latest one).

But when i type Doxygen -V i get 1.6.1.

Regards,
Aketh T. M

On 28 April 2015 at 22:29, albert [via Doxygen] <
ml-...@n7...> wrote:

> Aketh,
>
> You specify doxygen version 1.6.1 (which is from August 2009) and you use
> a recent dot version. Do you get the same problems with the current version
> of doxygen(1.8.9.1) and your dot version?
>
> Albert
>
> On Tue, Apr 28, 2015 at 1:59 PM, aketh <[hidden email]
> <http:///user/SendEmail.jtp?type=node&node=7163&i=0>> wrote:
>
>> Hi all I installed Doxygen and graphviz tool.
>>
>> I am trying to create a call graph for baroclinic.F90 file of CESM.
>>
>> However when I run firefox index.html, I got a blank browser. through file
>> tab's "open file" was blank even after, I browsed to the path of
>> baroclinic.F90.
>>
>> On trying dot to open a few .dot files, I got these errors.
>>
>> dot graph_legend.dot
>> There is no layout engine support for "dot"
>> Perhaps "dot -c" needs to be run (with installer's privileges) to register
>> the plugins?
>>
>> Can this be the issue?
>>
>> My version of dot is dot - graphviz version 2.38.0 (20140413.2041) and
>> 1.6.1
>> doxygen.
>>
>> thanks in advance,
>> Aketh
>>
>>
>>
>>
>>
>>
>> --
>> View this message in context:
>> http://doxygen.10944.n7.nabble.com/Browser-shows-nothing-in-the-index-file-tp7161.html
>> Sent from the Doxygen - Users mailing list archive at Nabble.com.
>>
>>
>> ------------------------------------------------------------------------------
>> 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
>> [hidden email] <http:///user/SendEmail.jtp?type=node&node=7163&i=1>
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>
>
> ------------------------------------------------------------------------------
>
> 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
> [hidden email] <http:///user/SendEmail.jtp?type=node&node=7163&i=2>
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
> ------------------------------
>  If you reply to this email, your message will be added to the discussion
> below:
>
> http://doxygen.10944.n7.nabble.com/Browser-shows-nothing-in-the-index-file-tp7161p7163.html
>  To unsubscribe from Browser shows nothing in the index file, click here
> <http://doxygen.10944.n7.nabble.com/template/NamlServlet.jtp?macro=unsubscribe_by_code&node=7161&code=YWtldGgudG1AZ21haWwuY29tfDcxNjF8NzUzMjM3MDc1>
> .
> NAML
> <http://doxygen.10944.n7.nabble.com/template/NamlServlet.jtp?macro=macro_viewer&id=instant_html%21nabble%3Aemail.naml&base=nabble.naml.namespaces.BasicNamespace-nabble.view.web.template.NabbleNamespace-nabble.view.web.template.NodeNamespace&breadcrumbs=notify_subscribers%21nabble%3Aemail.naml-instant_emails%21nabble%3Aemail.naml-send_instant_email%21nabble%3Aemail.naml>
>




--
View this message in context: http://doxygen.10944.n7.nabble.com/Browser-shows-nothing-in-the-index-file-tp7161p7164.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] Browser shows nothing in the index file

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

Aketh,

You specify doxygen version 1.6.1 (which is from August 2009) and you use a
recent dot version. Do you get the same problems with the current version
of doxygen(1.8.9.1) and your dot version?

Albert

On Tue, Apr 28, 2015 at 1:59 PM, aketh <ake...@gm...> wrote:

> Hi all I installed Doxygen and graphviz tool.
>
> I am trying to create a call graph for baroclinic.F90 file of CESM.
>
> However when I run firefox index.html, I got a blank browser. through file
> tab's "open file" was blank even after, I browsed to the path of
> baroclinic.F90.
>
> On trying dot to open a few .dot files, I got these errors.
>
> dot graph_legend.dot
> There is no layout engine support for "dot"
> Perhaps "dot -c" needs to be run (with installer's privileges) to register
> the plugins?
>
> Can this be the issue?
>
> My version of dot is dot - graphviz version 2.38.0 (20140413.2041) and
> 1.6.1
> doxygen.
>
> thanks in advance,
> Aketh
>
>
>
>
>
>
> --
> View this message in context:
> http://doxygen.10944.n7.nabble.com/Browser-shows-nothing-in-the-index-file-tp7161.html
> Sent from the Doxygen - Users mailing list archive at Nabble.com.
>
>
> ------------------------------------------------------------------------------
> 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
>

Re: [Doxygen-users] VHDL: how to include elements of a record (and the associated comment)?

[mkk <mk...@gm...>]

I posted Dimitri a patch for this issue
 
checkout and compile the current GIT repository 

documenting a record should now work.

 --! \brief description for a type, which actually is a record

   type my_record_1 is record
      element_11 : std_logic;     --! comment for first element of
my_record_1
      element_12 : std_logic;     --! comment for second element of
my_record_1
   end record;



--
View this message in context: http://doxygen.10944.n7.nabble.com/VHDL-how-to-include-elements-of-a-record-and-the-associated-comment-tp7149p7162.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] Browser shows nothing in the index file

[aketh <ake...@gm...>]

Hi all I installed Doxygen and graphviz tool.

I am trying to create a call graph for baroclinic.F90 file of CESM.

However when I run firefox index.html, I got a blank browser. through file
tab's "open file" was blank even after, I browsed to the path of
baroclinic.F90.

On trying dot to open a few .dot files, I got these errors.

dot graph_legend.dot 
There is no layout engine support for "dot"
Perhaps "dot -c" needs to be run (with installer's privileges) to register
the plugins?

Can this be the issue?

My version of dot is dot - graphviz version 2.38.0 (20140413.2041) and 1.6.1
doxygen.

thanks in advance,
Aketh






--
View this message in context: http://doxygen.10944.n7.nabble.com/Browser-shows-nothing-in-the-index-file-tp7161.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] aketh.tm@gmail.com

[Aketh TM <ake...@gm...>]

ake...@gm...

Re: [Doxygen-users] Case-sensitive in Fortran

[Petr P. <pet...@se...>]

Hi Albert,

there is one inconvenience in current Doxygen/Fortran implementation. 
Doxygen ignores the case (ok, I can live with that) BUT it does not 
ignore the case in automatically created links, i.e., foo() or 
module::foo etc. creates a correct link, but FOO() and MODULE::FOO does 
not. Would it be possible to modify the code to make the automatic links 
in Fortran comment blocks case-insensitive as well? I am sure it is not 
as major change as making whole Doxygen/Fortran to keep the case. Thanks :)

Best Regards

Petr Parik

Dne 20.4.2015 v 18:36 albert napsal(a):
> Dear Evgenii,
>
> Please subscribe to the mailing list, maybe you will get more answers.
>
> Currently the Fortran interpreter in doxygen converts everything to lower
> case (as you noted), this is done as Fortran is a case insensitive language
> and otherwise it would be quite hard to link the different items within the
> Fortran part with each other (developers of Fortran code don't always stick
> to a fixed case convention in their code).
> There are plans to keep the case as used in the source code, but it is quite
> a big task to set everything to the right case, so this will happen when
> time permits.
>
> Albert
>
>
>
> --
> View this message in context: http://doxygen.10944.n7.nabble.com/Case-sensitive-in-Fortran-tp7142p7143.html
> Sent from the Doxygen - Users mailing list archive at Nabble.com.
>
> ------------------------------------------------------------------------------
> BPM Camp - Free Virtual Workshop May 6th at 10am PDT/1PM EDT
> Develop your own process in accordance with the BPMN 2 standard
> Learn Process modeling best practices with Bonita BPM through live exercises
> http://www.bonitasoft.com/be-part-of-it/events/bpm-camp-virtual- event?utm_
> source=Sourceforge_BPM_Camp_5_6_15&utm_medium=email&utm_campaign=VA_SF
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Plantuml error in vs environment

[Jörg K. <j.k...@pr...>]

i generate html, latex and xml.

playing around i found that i have the same issue with epstopdf program from latex output.

The tools are not reporting any error, they just seem to have incorrect exit code.

Searching the doxygen source code i found that on windows the handling of exit codes was "improved" for windows.

Maybe this could be an issue. But i am wondering why it should occur only in this visual studio environment.



-----Ursprüngliche Nachricht-----
Von:	Willem Bogaerts <w-...@dd...>
Gesendet:	Fr 24.04.2015 13:09
Betreff:	Re: [Doxygen-users] Plantuml error in vs environment
An:	Jörg Kreuzberger <j.k...@pr...>; 
> Are you creating CHM files? That will report an error, even if there is
> none.
> 
> On 24-4-2015 12:46, Jörg Kreuzberger wrote:
> > Hi!
> > 
> > i am using plantuml support in doxygen with 1.8.8.
> > 
> > after update to 1.8.9.1, i get errors in visual studio
> > environment. In a windows enviroment with only mingw support,
> > i.e. path set to mingw\bin everything is fine
> > 
> > if i run doxygen from the visual studio console, plantuml seems to return
> > an invalid exit code.
> > 
> > But plantuml itself seems to work. calling plantuml with the generated pu 
> file does work
> > as expected.
> > 
> > Also the slash/backslash handling seems not to be a problem.
> > 
> > Any hints?
> 
>

[Doxygen-users] Plantuml error in vs environment

[Jörg K. <j.k...@pr...>]

Hi!

i am using plantuml support in doxygen with 1.8.8.

after update to 1.8.9.1, i get errors in visual studio
environment. In a windows enviroment with only mingw support,
i.e. path set to mingw\bin everything is fine

if i run doxygen from the visual studio console, plantuml seems to return
an invalid exit code.

But plantuml itself seems to work. calling plantuml with the generated pu file does work
as expected.

Also the slash/backslash handling seems not to be a problem.

Any hints?

[Doxygen-users] VHDL: 'to' keyword in case statement is regarded as 'syntax error' (bug?)

[Fontaine, F. <Fil...@nl...>]

Hi all,



I just stumbled on something that seems like a bug in Doxygen to me. In VHDL you can use the keyword 'to' within a case statement. For example:



------

case some_integer is

    when 0 => -- do something



    when 1 to 5  =>  -- do something else

    when others =>  -- do this in all other situations

end case;

------



Although this is 'legal' (and synthesizeable) VHDL, Doxygen reports this 'to' keyword as a 'syntax error'. The resulting corresponding output of Doxygen is not complete after this.



Is there a way around this errror?



Thanks in advance,



Filip



P.S. I'm using Doxygen version 1.8.9.1 on Windows 7 (64-bit, Service Pack 1).

Re: [Doxygen-users] VHDL: how to include elements of a record (and the associated comment)?

[Fontaine, F. <Fil...@nl...>]

Hi Alasdair,



Thanks for the suggestion. Unfortunately, adding the '<' character doesn't help. This character just gets included as text in the documentation....



Filip



________________________________
Van: Ferro, Alasdair [Ala...@me...]
Verzonden: donderdag 23 april 2015 11:51
Aan: Fontaine, Filip; dox...@li...
Onderwerp: RE: [Doxygen-users] VHDL: how to include elements of a record (and the associated comment)?

Filip,

I think that you need to use --!< to document after the member. Have a look at http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#memberdoc

For example:

   --! description for a type, which actually is a record
   type my_record_1 is record
      element_11 : std_logic;     --!< comment for first element of my_record_1
      element_12 : std_logic;     --!< comment for second element of my_record_1
   end record;


Alasdair

Re: [Doxygen-users] VHDL: how to include elements of a record (and the associated comment)?

[Ferro, A. <Ala...@me...>]

Filip,

I think that you need to use --!< to document after the member. Have a look at http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#memberdoc

For example:

   --! description for a type, which actually is a record
   type my_record_1 is record
      element_11 : std_logic;     --!< comment for first element of my_record_1
      element_12 : std_logic;     --!< comment for second element of my_record_1
   end record;


Alasdair

From: Fontaine, Filip [mailto:Fil...@nl...]
Sent: 23 April 2015 10:44
To: dox...@li...
Subject: [Doxygen-users] VHDL: how to include elements of a record (and the associated comment)?


Hi all,



I just started using Doxygen for documentation of a VHDL project. I'm having a bit of a struggle documenting type definitions that consist of a record. Here's an example of my VHDL-code (in a package):



----------------------------------------------------

--! @file
--! @brief Just a brief description of the file



library IEEE;
    use IEEE.std_logic_1164.all;



--! @brief Here a brief description of the package
--! @details A more detailed description of the package



package pkg_test is



  --! description of just a type (no record)
  type just_a_type is (FIRST,SECOND);



   --! description for a type, which actually is a record
   type my_record_1 is record
      element_11 : std_logic;     --! comment for first element of my_record_1
      element_12 : std_logic;     --! comment for second element of my_record_1
   end record;



   --! Another type description, also a record
   type my_record_2 is record
      element_21 : std_logic;     --! comment for first element of my_record_2
      element_22 : std_logic;     --! comment for second element of my_record_2
   end record;



end package;

----------------------------------------------------



The individual element of the records are not included in Doxygen's output and the comments associated with these elements seem to end up in the output in places where you don't expect it (comment and code seems to get 'out of sync').

Is there anything wrong or missing in my comment-lines, or should I change some configuration settings to get this right?



Thanks in advance,



Filip



P.S. I'm using Doxygen version 1.8.9.1 on Windows 7 (64-bit, Service Pack 1).

________________________________


________________________________
The NLR disclaimer is valid for NLR e-mail messages.

This message is only meant for providing information. Nothing in this e-mail message amounts to a contractual or legal commitment on the part of the sender.

This message may contain information that is not intended for you. If you are not the addressee or if this message was sent to you by mistake, you are requested to inform the sender and delete the message. Sender accepts no liability for damage of any kind resulting from the risks inherent in the electronic transmission of messages.

________________________________

Re: [Doxygen-users] Warning message when documenting overloaded functions.

[didje <dia...@pd...>]

No, if I omit the \fn I still get the warning message



--
View this message in context: http://doxygen.10944.n7.nabble.com/Warning-message-when-documenting-overloaded-functions-tp7145p7150.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] VHDL: how to include elements of a record (and the associated comment)?

[Fontaine, F. <Fil...@nl...>]

Hi all,



I just started using Doxygen for documentation of a VHDL project. I'm having a bit of a struggle documenting type definitions that consist of a record. Here's an example of my VHDL-code (in a package):



----------------------------------------------------

--! @file
--! @brief Just a brief description of the file



library IEEE;
    use IEEE.std_logic_1164.all;



--! @brief Here a brief description of the package
--! @details A more detailed description of the package



package pkg_test is



  --! description of just a type (no record)
  type just_a_type is (FIRST,SECOND);



   --! description for a type, which actually is a record
   type my_record_1 is record
      element_11 : std_logic;     --! comment for first element of my_record_1
      element_12 : std_logic;     --! comment for second element of my_record_1
   end record;



   --! Another type description, also a record
   type my_record_2 is record
      element_21 : std_logic;     --! comment for first element of my_record_2
      element_22 : std_logic;     --! comment for second element of my_record_2
   end record;



end package;

----------------------------------------------------



The individual element of the records are not included in Doxygen's output and the comments associated with these elements seem to end up in the output in places where you don't expect it (comment and code seems to get 'out of sync').

Is there anything wrong or missing in my comment-lines, or should I change some configuration settings to get this right?



Thanks in advance,



Filip



P.S. I'm using Doxygen version 1.8.9.1 on Windows 7 (64-bit, Service Pack 1).

Re: [Doxygen-users] Warning message when documenting overloaded functions.

[<dam...@xc...>]

Hi
I document overloaded functions all the time with no problem. I never use
\fn. Do you get what you want if you omit the \fn?

/*!
* do something with i
*/
virtual void doSomething(int i);

- Damon



                                                                                                                           
  From:       didje <dia...@pd...>                                                                             
                                                                                                                           
  To:         dox...@li...,                                                                         
                                                                                                                           
  Date:       04/22/2015 11:22 AM                                                                                          
                                                                                                                           
  Subject:    [Doxygen-users] Warning message when documenting overloaded	functions.                                       
                                                                                                                           





I am getting a warning message when documenting overloaded functions.

I have an implementation class and a header class.
The header class declares two virtual functions, the second of which
overloads the first.

ClassA.h

/virtual void doSomething(int i);
virtual void doSomething(int i,int j);/


The implementation class implements each virtual function, as follows

/ClassA.cpp

void doSomething(int i) {
printf ("doSomething: %d", i);
}

void doSomething(int i,int j) {
printf ("doSomething: %d", i);
printf ("doSomething: %d", j);
}/

I need to document both doSomething functions in doxygen.
How do I do it?

I have tried documenting the .h file as follows:

*Attempt 1:*

/ClassA.h

/*!
* \fn void doSomething(int i)
* do something with i
*/
virtual void doSomething(int i);

/*!
* \fn void doSomething(int i, int j)
* do something with i and j
*/
virtual void doSomething(int i,int j);/

*Attempt 2:*

//*!
* \fn void doSomething(int i)
* do something with i
*/
virtual void doSomething(int i);

/*!
* \overload void doSomething(int i, int j)
* do something with i and j
*/
virtual void doSomething(int i,int j);/

I have also tried to document the .cpp file in the same way, with and
without documenting the .h file.

However, whichever way I try, I always get the same warning message, which
is:

ClassA.cpp: warning: no uniquely matching class member found for
void doSomething(int i)
Possible candidates:
virtual void doSomething(int i) at line 123 of file ClassA.h
virtual void doSomething(int i, int j) at line 135 of file Class.h

ClassA.cpp: warning: no uniquely matching class member found for
void doSomething(int i,int j)
Possible candidates:
virtual void doSomething(int i) at line 123 of file ClassA.h
virtual void doSomething(int i, int j) at line 135 of file Class.h

Note: Ideally I would prefer to document only the .cpp file and not the .h
file in order to resolve this problem.




--
View this message in context:
http://cp.mcafee.com/d/5fHCNEi6zqb2pEV78K8zzhOrKrhKyevphsuKrhKyevvod7bVEVdETh7fIEKf8CQrFK8Td7abMUSxGJo2JJzfUwE-ovrBPpYM-TbCQQb41PbX_nUQsEEIK9TWZOWrbVEVV5VNdWX3fbnhIyCHtN_BgY-F6lK1FJ4SOrLOb2rPUV5xcQsCXCM0q5gYIh-78Td7b37g7t3i10_-nM1tz2k29tnWkQzVsMj-1t2JCRvxek29uFDUDRR3Q2XHsbjBm52YRxOb3_0USxkfb4vwnrFYq5O5mUm-wafBiteFlKdLt00_MddLILzzpFr3GxVozY2XtfzgQKCy01tz2k29Ewl-Bd8-q831fU6y12JCRvxek29EwGp-9ZtgZ0QgeJMJelokUSeKrATknCpHd

Sent from the Doxygen - Users mailing list archive at Nabble.com.

------------------------------------------------------------------------------

BPM Camp - Free Virtual Workshop May 6th at 10am PDT/1PM EDT
Develop your own process in accordance with the BPMN 2 standard
Learn Process modeling best practices with Bonita BPM through live
exercises
http://cp.mcafee.com/d/k-Kr41ESyMCqehOby8UQsCXCQrEzDSkn7HCQrEzDTS3hO-qejqdQhPXabzO9J6WrydPhOyYedEqHm0HroP-8afC7SVsSvcfJOVJd2N0sO-_R-d7aabbyt-LsKCO-qeuhusjuKMPORQr8FGTsvVkffGhBrwqrjdICXYyMCY-ehojd79KVI04gH2kZFlSvbUgYKJIpBWKBVjPPfMDj22OFuMgbCphCTFVsSxkfb4vwnrFYq5O5mUm-wafBiteFlKdLt00_MddLILzzpFr3GxVozY2XtfzgQKCy01tz2k29Ewl-Bd8-q831fU6y12JCRvxek29EwGp-9ZtgZ0QgeJMJelokUSeKrdV7O
 event?utm_
source=Sourceforge_BPM_Camp_5_6_15&utm_medium=email&utm_campaign=VA_SF
_______________________________________________
Doxygen-users mailing list
Dox...@li...
http://cp.mcafee.com/d/1jWVIg6hESyMCqehOby8UQsCXCQrEzDSkn7HCQrEzDTS3hO-qejqdQhPXabzO9J6WrydPhOyYedEqHm0HroP-8afC7SVsSvcfJOVJd2N0sO-_R-d7aabbyt-LsKCO-qeuhusjuKMPORQr8FGTsvVkffGhBrwqrpdICXYyMCY-ehojd79KVIDeqR4IM-l9QWBmUSZQ03_0T3VkDj3VkDa3JsgG7ByfMbJQ-d3q5gYIh-1tKDNEn8lrxrW0E-l9QWBmUSZQ03_0QS-O-edCBIeG7ByfMbJQ-d3iWq805Sc9g8Cy1nWkQzVEwc4_wq84aSrl-4Vg8Cy2FDUDRR3Q3h0WT2QVlxjzoWVINfCWyhbQ7kG

[Doxygen-users] Warning message when documenting overloaded functions.

[didje <dia...@pd...>]

I am getting a warning message when documenting overloaded functions.

I have an implementation class and a header class.
The header class declares two virtual functions, the second of which
overloads the first.

ClassA.h

/virtual void doSomething(int i);
virtual void doSomething(int i,int j);/


The implementation class implements each virtual function, as follows

/ClassA.cpp

void doSomething(int i) {
printf ("doSomething: %d", i);
}

void doSomething(int i,int j) {
printf ("doSomething: %d", i);
printf ("doSomething: %d", j);
}/

I need to document both doSomething functions in doxygen. 
How do I do it?

I have tried documenting the .h file as follows:

*Attempt 1:*

/ClassA.h

/*!
* \fn void doSomething(int i)
* do something with i
*/
virtual void doSomething(int i);

/*!
* \fn void doSomething(int i, int j)
* do something with i and j
*/
virtual void doSomething(int i,int j);/

*Attempt 2:*

//*!
* \fn void doSomething(int i)
* do something with i
*/
virtual void doSomething(int i);

/*!
* \overload void doSomething(int i, int j)
* do something with i and j
*/
virtual void doSomething(int i,int j);/

I have also tried to document the .cpp file in the same way, with and
without documenting the .h file.

However, whichever way I try, I always get the same warning message, which
is:

ClassA.cpp: warning: no uniquely matching class member found for 
void doSomething(int i)
Possible candidates:
virtual void doSomething(int i) at line 123 of file ClassA.h
virtual void doSomething(int i, int j) at line 135 of file Class.h

ClassA.cpp: warning: no uniquely matching class member found for 
void doSomething(int i,int j)
Possible candidates:
virtual void doSomething(int i) at line 123 of file ClassA.h
virtual void doSomething(int i, int j) at line 135 of file Class.h

Note: Ideally I would prefer to document only the .cpp file and not the .h
file in order to resolve this problem.




--
View this message in context: http://doxygen.10944.n7.nabble.com/Warning-message-when-documenting-overloaded-functions-tp7145.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] Missing inheritance between classes

[Roland P. <ro...@rp...>]

I'm attempting to create some API documentation for a language of my
own. For this I made a small python filter converting the source code to
something resembling java just with all code removed from class
functions (empty function bodies). So it's like a C++ header just with
java notation since this better fits the features I have in my language.
The documentation works in general well but there is a strange problem I
don't know where to start looking for the problem. A few classes have
problems to properly link to their super/subclasses.

Let's say you have something like this inheritance

BaseClass:
   extended by SpecialClass

Now in some cases SpecialClass does not link to BaseClass although
showing it as superclass in the class view and vice versa for BaseClass
missing SpecialClass as subclass. In general doxygen seems to notice
those classes to be in an inheritance relationship but fails to reflect
this in the pages using links.

Any ideas what could cause this problem? I know it's difficult to look
at this using only this information but maybe some have witnessed
similar problems and remember what caused them these problems so I can
try out to somehow narrow it down.

-- 
Yours sincerely
Plüss Roland

Leader and Head Programmer
- Game: Epsylon ( http://www.indiedb.com/games/epsylon )
- Game Engine: Drag[en]gine ( http://www.indiedb.com/engines/dragengine
, http://dragengine.rptd.ch/wiki )
- Normal Map Generator: DENormGen ( http://epsylon.rptd.ch/denormgen.php )
- As well as various Blender export scripts und game tools

Re: [Doxygen-users] Case-sensitive in Fortran

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

Dear Evgenii,

Please subscribe to the mailing list, maybe you will get more answers.

Currently the Fortran interpreter in doxygen converts everything to lower
case (as you noted), this is done as Fortran is a case insensitive language
and otherwise it would be quite hard to link the different items within the
Fortran part with each other (developers of Fortran code don't always stick
to a fixed case convention in their code).
There are plans to keep the case as used in the source code, but it is quite
a big task to set everything to the right case, so this will happen when
time permits.

Albert



--
View this message in context: http://doxygen.10944.n7.nabble.com/Case-sensitive-in-Fortran-tp7142p7143.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] Fwd: Problems with brief description

[Alessandro A. <ant...@gm...>]

You may need to use the @brief command before your brief explanation and
@details in front of the detailed explanation.
On Apr 16, 2015 10:57 AM, "Alessandro Antonello" <ant...@gm...>
wrote:

> Hi everyone,
>
> My question is: what could cause a brief description to appear as a '!'
> sign
> in the HTML documentation output?
>
> I had set JAVADOC_AUTOBRIEF = YES in the configuration file. I wrote my
> classes like:
>
> -----------------------------------------------------------
> /**
>  * This should be the brief.
>  * This is the detailed description.
>  */
> class MyClass
> {
> };
> -----------------------------------------------------------
>
> In the list of classes the related item appears as:
>
> -----------------------------------------------------------
> class MyClass ! More...
> -----------------------------------------------------------
>
> In the class page documentation it also appears that way.
>
> -----------------------------------------------------------
> MyClass Class Reference
> ! More...
> -----------------------------------------------------------
>
> Also in The deails.
>
> -----------------------------------------------------------
> Detailed Description
> !
> This should be the brief.
> This is the detailed description.
> -----------------------------------------------------------
>
> Since there are no '!' characters in the documentation, what could cause
> that
> problem? All C++ files are encoded using UTF-8. That was correctly
> configured
> in the doxygen configuration file.
>
> I also tried specificaly setting the brief with '@brief'. Got same result.
>
>
>
>
​Hi Robert.
Tanks for your answer. I found what was going wrong. Before each comment
block I had a conditional comment section that I mistakenly wrote as
follows:

--------------------------------------------------------------------------
///! \cond my_cond

///! \endcond
​--------------------------------------------------------------------------

For some reason the '!' character in this conditional section is leaking to
the next comment block. When I removed the '!' characters from the
conditional section the HTML output becomes correct.

Thanks for your help.