doxygen-users — List for users of doxygen

Re: [Doxygen-users] Formulas in code blocks

[Dimitri v. H. <do...@gm...>]

Hi Christoph,

This seems to be a standard feature of MathJax, see also
https://docs.mathjax.org/en/v2.6-latest/start.html#tex-and-latex-input

It has nothing to do with doxygen, but one could argue that doxygen
should prevent MathJax from doing this, unless it is a real formula.
Feel free to file a bug report for this.

Regards,
  Dimitri

> On 14 Feb 2016, at 23:13 , Christoph Lehmann <c_l...@po...> wrote:
> 
> Dear all,
> 
> I just found out by chance that formulas can be included in code
> snippets if MathJax is enabled. In the following examples \sum will be
> rendered as the respective LaTeX symbol in the HTML output.
> 
> \code
> while true; do
>    \( \sum \)
> done
> \endcode
> 
> ~~~~~
> while true; do
>    \( \sum \)
> done
> ~~~~~
> 
> However, I could not find that behaviour documented anywhere and
> actually I found out about it when trying to include the following
> snippet into the documentation:
> 
> \code
> find . \( -name '*.h' -and -not -name '*-impl.h' \) -printf '%f\n'
> \endcode
> 
> Everything between the brackets was interpreted as some LaTeX formula
> and thus messed up pretty much. That also applies if I specify
> {.unparsed} as "language".
> 
> Is the observed behaviour intended or is it merely a bug? Is there some
> documentation somewhere? As a feature it would be very nice, but is
> there also a possibility to disable the special meaning of \( and \) in
> code snippets?
> 
> Best regards,
> Christoph
> 
> ------------------------------------------------------------------------------
> Site24x7 APM Insight: Get Deep Visibility into Application Performance
> APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
> Monitor end-to-end web transactions and take corrective actions now
> Troubleshoot faster and improve end-user experience. Signup Now!
> http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Formulas in code blocks

[Christoph L. <c_l...@po...>]

Dear all,

I just found out by chance that formulas can be included in code
snippets if MathJax is enabled. In the following examples \sum will be
rendered as the respective LaTeX symbol in the HTML output.

\code
while true; do
    \( \sum \)
done
\endcode

~~~~~
while true; do
    \( \sum \)
done
~~~~~

However, I could not find that behaviour documented anywhere and
actually I found out about it when trying to include the following
snippet into the documentation:

\code
find . \( -name '*.h' -and -not -name '*-impl.h' \) -printf '%f\n'
\endcode

Everything between the brackets was interpreted as some LaTeX formula
and thus messed up pretty much. That also applies if I specify
{.unparsed} as "language".

Is the observed behaviour intended or is it merely a bug? Is there some
documentation somewhere? As a feature it would be very nice, but is
there also a possibility to disable the special meaning of \( and \) in
code snippets?

Best regards,
Christoph

[Doxygen-users] Merge two Documentations

[T_Schm <sch...@gm...>]

Hi guys,

I love doxygen. Right now, I try to create some info pages that contain
concepts and design patterns. I want to link to certain classes inside those
pages.
But since my project has become pretty large, the creation of the
documentation takes quite some while. I created a documentation only for the
pages now to speed up the creation time when I changed something and want to
check the changes. Is there a way to build only a special builder and leave
the rest of the documentation untouched? 

My target is to have the full class documentation of my project and only
change the doc pages. This would mean the class doc is fixed and only pages
are updated when I build.

Is there a way to do such a thing?
Best regards,
Thorsten



--
View this message in context: http://doxygen.10944.n7.nabble.com/Merge-two-Documentations-tp7534.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] New things I have learned.

[Doug R. <dou...@gm...>]

I have been using doxygen for a while. Recently I started documenting a
large project.

Three rather obvious things I have learned in the last week to be
careful of.

 (1) Don't name a page 'Math' as in: @page Math ...

 (2) When you copy a C/C++ header file, don't forget edit the brief
comments in the new-copied file for the class names before running
doxygen again. Else you get lots of extra stuff in the method page.

It results in the left menu highlighting two items at once, one for each
matching class name (two Abs() methods that both highlight at the same
time).

 (3) When copying a Doxyfile, don't forget to change the output path
before running doxygen. Else you get the wrong PNG files in you method
pages.

The results were rather amusing. Formulas and text documenting utterly
unrelated methods. I thought I was going nuts. I kept looking in the
wrong file for comments that were not in the file at all. Then when I
would click on what I thought was the documentation for a constructor,
it beautifully showed formulas for complex number multiplication along
with nice MathJax formulas that were not in those comments. Seems
because of (3) the formula_xx.png from the one library overwrote the
correct ones from the first library.

After having been a programmer for about 40 years, I knew that doxygen
could not be that broke.

So if you think your going nuts, you may be, however doxygen is not :-)


-- 

Doug Royer - (http://DougRoyer.US)
Dou...@gm...
714-989-6135

Re: [Doxygen-users] Three slashes for brief comment

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

In a number of cases (not sure about which) adding /// \file  on the top of
the file helps.

Albert

On Thu, Feb 4, 2016 at 4:03 PM, Christoph Lipka <chr...@li...>
wrote:

> Hi Florian,
>
> to quote from the docs:
>
> "For the *brief* description there are also several possibilities:
>
>  1.
>
>     One could use the \brief
>     <http://www.stack.nl/%7Edimitri/doxygen/manual/commands.html#cmdbrief>
>     command [...]
>
>  2.
>
>     If JAVADOC_AUTOBRIEF
>     <
> http://www.stack.nl/%7Edimitri/doxygen/manual/config.html#cfg_javadoc_autobrief
> >
>     is set to |YES| in the configuration file, then [...]
>
>  3.
>
>     A third option is to use a special *C++ style comment* which does
>     not span more than *one line*. Here are two examples:
>
>     /// Brief description.
>     /** Detailed description. */
>
>     or
>
>     //! Brief description.
>
>     //! Detailed description
>     //! starts here.
>
>     Note the blank line in the last example, which is required to
>     separate the brief description from the block containing the
>     detailed description. The JAVADOC_AUTOBRIEF
>     <
> http://www.stack.nl/%7Edimitri/doxygen/manual/config.html#cfg_javadoc_autobrief
> >
>     should also be set to |NO| for this case."
>
> (emphasis added).
>
> In other words, you're doing it perfectly right, and the behaviour is
> officially supported.
>
>
> Am 04.02.2016 um 09:31 schrieb Florian Lindner:
> > Hello,
> >
> > I use this syntax to make a only a brief description:
> >
> >   /// true if the mapping along some axis should be ignored
> >   bool* _deadAxis;
> >
> > JAVADOC_AUTOBRIEF is off, almost everything else is doxygens default.
> >
> > It seems to work fine, the result is the same as prefixed with //
> > @brief foobar.
> >
> > But I have found it in the documentation nowhere.
> >
> > There is something like that mentioned in
> > http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html but it talks
> > about at least two comment lines.
> >
> > Is the syntax above ok that way? Or will it eventually cease to work
> > some day?
> >
> > Thanks,
> > Florian
> >
> >
> >
> >
> ------------------------------------------------------------------------------
> > Site24x7 APM Insight: Get Deep Visibility into Application Performance
> > APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
> > Monitor end-to-end web transactions and take corrective actions now
> > Troubleshoot faster and improve end-user experience. Signup Now!
> > http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140
> > _______________________________________________
> > Doxygen-users mailing list
> > Dox...@li...
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
> >
>
>
>
> ------------------------------------------------------------------------------
> Site24x7 APM Insight: Get Deep Visibility into Application Performance
> APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
> Monitor end-to-end web transactions and take corrective actions now
> Troubleshoot faster and improve end-user experience. Signup Now!
> http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

Re: [Doxygen-users] Three slashes for brief comment

[Christoph L. <chr...@li...>]

Hi Florian,

to quote from the docs:

"For the *brief* description there are also several possibilities:

 1.

    One could use the \brief
    <http://www.stack.nl/%7Edimitri/doxygen/manual/commands.html#cmdbrief>
    command [...]

 2.

    If JAVADOC_AUTOBRIEF
    <http://www.stack.nl/%7Edimitri/doxygen/manual/config.html#cfg_javadoc_autobrief>
    is set to |YES| in the configuration file, then [...]

 3.

    A third option is to use a special *C++ style comment* which does
    not span more than *one line*. Here are two examples:

    /// Brief description.
    /** Detailed description. */

    or

    //! Brief description.

    //! Detailed description 
    //! starts here.

    Note the blank line in the last example, which is required to
    separate the brief description from the block containing the
    detailed description. The JAVADOC_AUTOBRIEF
    <http://www.stack.nl/%7Edimitri/doxygen/manual/config.html#cfg_javadoc_autobrief>
    should also be set to |NO| for this case."

(emphasis added).

In other words, you're doing it perfectly right, and the behaviour is
officially supported.


Am 04.02.2016 um 09:31 schrieb Florian Lindner:
> Hello, 
>
> I use this syntax to make a only a brief description: 
>
>   /// true if the mapping along some axis should be ignored 
>   bool* _deadAxis; 
>
> JAVADOC_AUTOBRIEF is off, almost everything else is doxygens default. 
>
> It seems to work fine, the result is the same as prefixed with //
> @brief foobar. 
>
> But I have found it in the documentation nowhere. 
>
> There is something like that mentioned in 
> http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html but it talks 
> about at least two comment lines. 
>
> Is the syntax above ok that way? Or will it eventually cease to work
> some day? 
>
> Thanks, 
> Florian 
>
>
>
> ------------------------------------------------------------------------------
> Site24x7 APM Insight: Get Deep Visibility into Application Performance
> APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
> Monitor end-to-end web transactions and take corrective actions now
> Troubleshoot faster and improve end-user experience. Signup Now!
> http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

[Doxygen-users] Three slashes for brief comment

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

Hello, 

I use this syntax to make a only a brief description: 

  /// true if the mapping along some axis should be ignored 
  bool* _deadAxis; 

JAVADOC_AUTOBRIEF is off, almost everything else is doxygens default. 

It seems to work fine, the result is the same as prefixed with //
@brief foobar. 

But I have found it in the documentation nowhere. 

There is something like that mentioned in 
http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html but it talks 
about at least two comment lines. 

Is the syntax above ok that way? Or will it eventually cease to work
some day? 

Thanks, 
Florian 

Re: [Doxygen-users] Left Manu/Index not syncing correctly

[Doug R. <dou...@gm...>]

Works again !!!

I changed:

	 @page Math Documentation for the libSaSMath library

to:

	 @page SaSMath Documentation for the libSaSMath library

And all starting working again.

Thanks for your help!


On 01/29/2016 12:28 PM, Dimitri van Heesch wrote:
> Hi Doug,
> 
> I think the problem is that you have a page called "Math" with subpages.
> As a result doxygen generates a script called Math.js containing a piece of navigation code for the tree view.
> This in turn hides functions like Math.cos(), which jquery depends on, giving a javascript error, and halting 
> the script.
> 
> As a workaround can you see if renaming the Math page (with title: Documentation for the libSaSMath library)
> makes things work again?
> 
> Regards,
>   Dimitri
> 
-- 

Doug Royer - (http://DougRoyer.US)
Dou...@gm...
714-989-6135

[Doxygen-users] Support and compatibility against Win Server 2008R2 and Win Server 2012R2

[Abhaya G. <Abh...@ec...>]

Hi ,

I am seeking some information like support and Compatibility of below products for platforms Win Server 2008R2 and Win Server 2012R2

OxyGen 1.0.0

Please provide the support and compatibility results for above mentioned OS platforms , Also you can provide us the details if any other support/contact channels are available.

Thanks in advance.
Regards,

Abhaya Ghatkar
Trainee Engineer

Email:  Abh...@ec...<mailto:Abh...@ec...>

[cid:imagea7d98b.PNG@ca5caf98.49817394]        [cid:image8bfb49.GIF@4f78b3e8.4d900b9c] <https://www.facebook.com/ECS-176915995976820/>  [LinkedIn] <https://www.linkedin.com/company/597750?trk=tyah&trkInfo=clickedVertical%3Acompany%2CclickedEntityId%3A597750%2Cidx%3A2-2-5%2CtarId%3A1438849071372%2Ctas%3Aecs>  [Twitter] <https://www.twitter.com/ECS_IT>

Glasgow     .     London     .     Leeds     .     Edinburgh     .     Manchester     .     Pune     .     Johannesburg

This message may contain privileged/confidential information. If you are not the intended recipient, please inform ECS and delete this message immediately.

Note: This message has been virus scanned by ECS before sending. Neither ECS, nor the sender, accept any responsibility for viruses and it is your responsibility to scan or otherwise check this email and any attachments. Any views, opinions, conclusions or other information in this message that do not relate to the business of ECS are not authorised by us. In addition, ECS does not accept responsibility for any changes made to this message after it was originally sent.

ECS is a group of limited companies incorporated in Scotland with Head Offices registered at Parkview House, 6 Woodside Place, Glasgow G3 7QF.

ECS Europe Ltd Reg No. SC357435    ECS Global Ltd Reg No. SC348886    ECS Security Ltd Reg No. SC418589    ECS Consultancy Ltd Reg No.SC436053

P Please consider the environment before printing this e-mail.
________________________________

Re: [Doxygen-users] Left Manu/Index not syncing correctly

[Dimitri v. H. <do...@gm...>]

Hi Doug,

I think the problem is that you have a page called "Math" with subpages.
As a result doxygen generates a script called Math.js containing a piece of navigation code for the tree view.
This in turn hides functions like Math.cos(), which jquery depends on, giving a javascript error, and halting 
the script.

As a workaround can you see if renaming the Math page (with title: Documentation for the libSaSMath library)
makes things work again?

Regards,
  Dimitri

> On 27 Jan 2016, at 21:42 , Doug Royer <dou...@gm...> wrote:
> 
> 
> I have tried doxygen versions 1.8.12 (git pull) and 1.8.9.1 (Ubuntu
> 15.10) and I get similar messed up results.
> 
> The menu items on the left do not work any more. When you click on the
> expand triangle, nothing happens. The only way to make them work is to
> click on the top menu, then it seems sometimes to active the left menu.
> 
> The TOP menu items work. They populate the main area with the correct
> content.
> 
> Example that is failing:
> 
> http://SoftwareAndServices.US/Documentation/public/SaSLibraries/html/index.html
> 
> 
> Click the *expansion triangle* "Documentation for the libSaSMath
> library" on the left. Nothing happens.
> 
> Then click on "Math - Complex Number Object" in the left area.
> Only then does the left menu item expand.
> 
> The documentation itself is incomplete - however its difficult to test
> the documentation and create it when the generated output fails to
> operate correctly..
> 
>   -->> AND THANKS FOR THIS AWESOME SOFTWARE <<---
> 
> -- 
> 
> Doug Royer - (http://DougRoyer.US)
> Dou...@gm...
> 714-989-6135
> 
> ------------------------------------------------------------------------------
> Site24x7 APM Insight: Get Deep Visibility into Application Performance
> APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
> Monitor end-to-end web transactions and take corrective actions now
> Troubleshoot faster and improve end-user experience. Signup Now!
> http://pubads.g.doubleclick.net/gampad/clk?id=267308311&iu=/4140_______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Left Manu/Index not syncing correctly

[Doug R. <dou...@gm...>]

I have tried doxygen versions 1.8.12 (git pull) and 1.8.9.1 (Ubuntu
15.10) and I get similar messed up results.

The menu items on the left do not work any more. When you click on the
expand triangle, nothing happens. The only way to make them work is to
click on the top menu, then it seems sometimes to active the left menu.

The TOP menu items work. They populate the main area with the correct
content.

Example that is failing:

http://SoftwareAndServices.US/Documentation/public/SaSLibraries/html/index.html


Click the *expansion triangle* "Documentation for the libSaSMath
library" on the left. Nothing happens.

Then click on "Math - Complex Number Object" in the left area.
Only then does the left menu item expand.

The documentation itself is incomplete - however its difficult to test
the documentation and create it when the generated output fails to
operate correctly..

   -->> AND THANKS FOR THIS AWESOME SOFTWARE <<---

-- 

Doug Royer - (http://DougRoyer.US)
Dou...@gm...
714-989-6135

Re: [Doxygen-users] Need a specific help with xrefitem command

[dharakshah <dha...@in...>]

Hi Fabi ,
Thanks for the reply.

I have added perl script through FILTER_PATTERNS and doxygen is generating
desired output.
Basically I am using xrefitem twice.
Like:
/// \fixme \owner comment
/// \owner1 \fixme1 comment

where:
ALIASES += owner="\link owner.html owner \endlink" \
ALIASES += fixme="\xrefitem fixme \"FIXME\" \"FIXMEs\"" \
ALIASES += owner1="\xrefitem owner \"owner\" \"Owner Page\""
ALIASES += fixme1="\link fixme.html Fixme \endlink" \

But I am adding 2nd line during the reprocessing ( FILTER_PATTERNS script -
regexs)
And in css I am hiding 2nd repeating documentation.

So Now I am able to generate 2 pages fixme.html and owner.html with cross
referenced.

Thanks,
Dharak




--
View this message in context: http://doxygen.10944.n7.nabble.com/Need-a-specific-help-with-xrefitem-command-tp7523p7525.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] Need a specific help with xrefitem command

[Fabian C. <Cen...@in...>]

At 00:32 25.01.2016, dharakshah wrote:
>Hi, I have specific questioon on usage of xrefitem. 
>
>I have comment like: 
>/// \fixme owner1 comment1.... 
>some code 
>
>/// \fixme owner2 comment2.... 
>some code 
>
>/// \todo owner1 comment3.... 
>some code 
>
>Now by using a xrefitem : fixme="\xrefitem fixme \"FIXME\" \"FIXMEs\"" 
>I am able to create a page called FIXME.html 
>
>Now I have fixmes and todos associated with owners. 
>I want to generate a html page for each owner and they should listed all
>fixmes and todos for that owner. Output should be 
>owner1.html
>Fixme : comment1 
>todo : comment3 
>
>owner2.html 
>Fixme: comment2 
>
>Can you please suggest a way if it is possible? 

It's probably the easiest to process the generated file and create the
owner html files yourself. If you use a scripting language with html/xml
support you don't need to parse the fixme file manually.

bye  Fabi

Re: [Doxygen-users] VHDL Process Comments Grouped Wrong

[spaceman_spiff <pad...@gm...>]

I kept digging and found a work around for this issue.

This appears to be related to conditionals. If, for instance, I have the
code below without a dummy signal work around, all comments for processes
(and functions) get shifted to the wrong processes (and functions). 

e.g. For the below example, comments to be associated with example_process1
are erroneously associated with example_process2. 

I've found a temporary workaround. If I define a dummy signal between the
conditional and the 1st process, the comments will be grouped correctly.

This may be due to some bug within Doxygen. It seems that Doxygen expects
signals to be documented, and if they are all excluded with a conditional,
you get some sort of associative problem with process or function comments.

--! @cond SIGNALS_TO_EXCLUDE
signal signal_A : std_logic;
signal signal_B : std_logic;
signal signal_n : std_logic;
--! @endcond

-- This signal is a bug workaround for Doxygen. If it is excluded, the
process comments get jacked up
signal dummy_signal : std_logic; 

begin

---------------------------------
--! @brief This is a process that flips a bit
--!
--! @param[in] CLK, 250MHz
---------------------------------
example_process1: process(CLK)
begin
    if rising_edge(CLK) then
         if RST = '1' then
              ibit <= '0';
         else
              ibit <= not ibit;
         end if;
    end if;
end process; 

---------------------------------
--! @brief This is a counter
--!
--! This counter counts to c_max_count
--! then retains its value.
--!
--! @param[in] CLK, 250MHz
---------------------------------
example_process2: process(CLK)
begin
    if rising_edge(CLK) then
         if RST = '1' then
              icount <= (others => '0');
         elsif icount /= c_mac_count then
              icount <= icount + '1';
         else
              icount <= icount;
         end if;
    end if;
end process; 



--
View this message in context: http://doxygen.10944.n7.nabble.com/VHDL-Process-Comments-Grouped-Wrong-tp7519p7520.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] VHDL Process Comments Grouped Wrong

[spaceman_spiff <pad...@gm...>]

I'm new to Doxygen and am setting up my process statements like the
following; however, they are grouped incorrectly. When I output the html,
all comments associated with example_process1 are grouped with
example_process2.
In my actual code, they are all off by one grouping. Process 1 groups with
process 2, 2 with 3, 3 with 4, etc. What am i doing wrong?

---------------------------------
--! @brief This is a process that flips a bit
--!
--! @param[in] CLK, 250MHz
---------------------------------
example_process1: process(CLK)
begin
    if rising_edge(CLK) then
         if RST = '1' then
              ibit <= '0';
         else
              ibit <= not ibit;
         end if;
    end if;
end process;

---------------------------------
--! @brief This is a counter
--!
--! This counter counts to c_max_count
--! then retains its value.
--!
--! @param[in] CLK, 250MHz
---------------------------------
example_process2: process(CLK)
begin
    if rising_edge(CLK) then
         if RST = '1' then
              icount <= (others => '0');
         elsif icount /= c_mac_count then
              icount <= icount + '1';
         else
              icount <= icount;
         end if;
    end if;
end process;


______________________________
My system:
Windows 7 professional 64 bit
Doxygen version 1.8.11
Xilinx ISE 14.7

<<<<<>>>>> 



--
View this message in context: http://doxygen.10944.n7.nabble.com/VHDL-Process-Comments-Grouped-Wrong-tp7519.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] Fortran INCLUDE statement

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

Petr,

Indeed include statements are ignored in FORTRAN, I don't have a direct
solution for it other hat using an INPUT_FILTER (or other FILTER
posibilities) that includes the (possible recursive) include code and hands
this over to doxygen.

Albert

On Fri, Jan 15, 2016 at 10:02 PM, Petr Parik <pet...@se...> wrote:

> Hi all,
>
> Doxygen seems to ignore INCLUDE statements in Fortran, for example:
>
> MODULE TEST
>    INCLUDE 'defs.f'
> CONTAINS
>    INCLUDE 'routines.f'
> END
>
> Here the included files cannot be processed separately because the code
> would not have the correct scope.
>
> Please help, how can I get it to work?
>
> Best Regards
>
> Petr Parik
>
>
> ------------------------------------------------------------------------------
> Site24x7 APM Insight: Get Deep Visibility into Application Performance
> APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
> Monitor end-to-end web transactions and take corrective actions now
> Troubleshoot faster and improve end-user experience. Signup Now!
> http://pubads.g.doubleclick.net/gampad/clk?id=267308311&iu=/4140
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

[Doxygen-users] Fortran INCLUDE statement

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

Hi all,

Doxygen seems to ignore INCLUDE statements in Fortran, for example:

MODULE TEST
   INCLUDE 'defs.f'
CONTAINS
   INCLUDE 'routines.f'
END

Here the included files cannot be processed separately because the code 
would not have the correct scope.

Please help, how can I get it to work?

Best Regards

Petr Parik

[Doxygen-users] xrefitem lists - how to suppress output, similar to GENERATE_TODOLIST usage?

[Monique S. <mon...@ea...>]

Hello, Doxygen users,

In Doxygen 1.8.10 (on Win7), is there any way to include/omit a list that’s generated via \xrefitem commands?

For the standard \todo list page, the Doxygen configuration setting, GENERATE_TODOLIST, includes/omits the page from the output. And so I’d like something like that for my multiple \xrefitem lists.

I do have a workaround. I already have two config files, Doxyfile and Doxyfile_todo, that are identical except for the GENERATE_TODO setting: it’s = NO in Doxyfile, and = YES in Doxyfile_todo. This way I ensure that nobody accidentally includes \todo items in output that’s intended for customers. So since I’m maintaining two separate files anyway, and I’m using the \xrefitem commands in ALIASES, I can have the alias be set to the standard \todo command in Doxyfile, and to the \xrefitem in the Doxyfile_todo.

But it’d be nicer if I could create a setting that’s analogous to GENERATE_TODOLIST...

Thanks,
-Monique

Re: [Doxygen-users] call graph problems

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

Hi Lorenz,

Happy new year to you as well.

Good to hear that the problem seems to be solved.

Best Regards,

Albert


On Mon, Jan 11, 2016 at 3:05 PM, Lorenz <lor...@ya...> wrote:

> Hi Albert,
>
> happy new year
>
> Albert wrote:
> >I've tested it with the 1.8.10 version now as well and I see that here the
> >graphs for method3/4 and method9/10 are missing. So I think it was a bug
> in
> >the 1.8.10 version.
> >(I don't think you were using 1.8.11 but 1.8.10 as doxygen 1.8.11 was
> >released on December 30,2015 and you didn't mentioning using the git
> >repository version.)
>
> you're right, I was running 1.8.10 on my tests.
>
> I've just run my original project through 1.8.11 and have not found
> any missing graphs so far.
>
> So it seems 1.8.11 fixed the problem I was seeing.
>
> Thanks again for looking into this.
> --
>
> Lorenz
>
>
>
> ------------------------------------------------------------------------------
> Site24x7 APM Insight: Get Deep Visibility into Application Performance
> APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
> Monitor end-to-end web transactions and take corrective actions now
> Troubleshoot faster and improve end-user experience. Signup Now!
> http://pubads.g.doubleclick.net/gampad/clk?id=267308311&iu=/4140
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

[Doxygen-users] Options for tweaking how connections are made

[Seaders O. <sea...@gm...>]

I posted one part of my question to StackOverflow,
http://stackoverflow.com/questions/34639432/syntactical-sugar-for-doxygen-to-link-a-monobehaviour-with-unity3d,
but it hasn't gotten a huge response, so thought I might be better trying
here.

Basically, I'd like to be able to add some sort of syntactical sugar, meta
information, or configuration to enable Doxygen to manually enter a
connection into it.  One example of this is the SO question, to create a
new MonoBehaviour, in the proper Unity3d environment, you pass a classfile
to be added to an active GameObject, and Unity takes care of the rest.  So,
while your code will call the new MonoBehaviour's constructor, Awake, and
Start methods, that doesn't get tracked and then doesn't get shown in the
graphs.

On a similar level, if you're making cross-platform apps, you will also
have native Java and iOS code, but you create these with meta functions,
that connect with exposed functions from the native side.  Again, I don't
in any way know how Doxygen could do this, nor expect it to be able to do
it automatically, but if it's possible, I'd love to be able to add some
syntactical sugar that lets Doxygen know this connection should be made to
some function on Unity's side in C#, and the native side in Java /
Objective-C in the docs.

Then, on the other side I'd also like to mark some connections as not to be
tracked by Doxygen.  A simple example of when you'd want this is in an iOS
/ XCode project, so that it would ignore that things inherit from NSObject,
because in a large project, it results in hundreds of files showing as
children of it.

Last question is a more general version of filtering things out from
Doxygen / GraphViz.  Currently if I run it against my Android project, it
makes a number of connections to Android .R files
("android.support.design.R" / "android.support.v7.appcompat.R"), which
again are unwanted.  Is the only way to exclude some references to some
files by literally excluding the files / directories these classes are
coming from, or is there any "meta" way to exclude classes or packages
within Doxygen?

Many thanks for Doxygen and any and all support, it's all very much
appreciated.

Re: [Doxygen-users] call graph problems

[Lorenz <lor...@ya...>]

Hi Albert,

happy new year

Albert wrote:
>I've tested it with the 1.8.10 version now as well and I see that here the
>graphs for method3/4 and method9/10 are missing. So I think it was a bug in
>the 1.8.10 version.
>(I don't think you were using 1.8.11 but 1.8.10 as doxygen 1.8.11 was
>released on December 30,2015 and you didn't mentioning using the git
>repository version.)

you're right, I was running 1.8.10 on my tests.

I've just run my original project through 1.8.11 and have not found
any missing graphs so far.

So it seems 1.8.11 fixed the problem I was seeing.

Thanks again for looking into this.
-- 

Lorenz

Re: [Doxygen-users] Looking for beta testers of a Doxygen GitHub integration

[Baptiste W. <bap...@gm...>]

On Sat, Jan 09, 2016 at 01:27:56PM -0500, Paul Novotny wrote:
> On Thu, Jan 7, 2016, at 09:25 AM, Paul Novotny wrote:
> > On Thu, 2016-01-07 at 09:47 +0100, Baptiste Wicht wrote:
> > > Hi Paul,
> > >
> > > This is an excellent idea :)
> > >
> > > I may be doing something wrong, but when I go on the site, only some
> > > of
> > > my repositories are displayed, it seems the first X in alphabetical
> > > order. Is there a limit ?
> > >
> > > The projects I wanted to tests are not displayed.
> >
> > 112 repositories, wow, you are a good tester. :-) It looks like github
> > is sending me repositories in bunches, but I never knew that since all
> > the repositories always fit into the first bunch. I should have a fix
> > up shortly.
>
> Hi Baptiste, I think I solved the problem, please give it a try and let
> me know if you see all of your repositories.
> -Paul

Hi Paul,

Yes, it works fine with my long list of repositories now :)

Thanks

Baptiste

Re: [Doxygen-users] Looking for beta testers of a Doxygen GitHub integration

[Paul N. <pa...@pa...>]

On Thu, Jan 7, 2016, at 09:25 AM, Paul Novotny wrote:
> On Thu, 2016-01-07 at 09:47 +0100, Baptiste Wicht wrote:
> > Hi Paul,
> > 
> > This is an excellent idea :)
> > 
> > I may be doing something wrong, but when I go on the site, only some
> > of
> > my repositories are displayed, it seems the first X in alphabetical
> > order. Is there a limit ?
> > 
> > The projects I wanted to tests are not displayed.
> 
> 112 repositories, wow, you are a good tester. :-) It looks like github
> is sending me repositories in bunches, but I never knew that since all
> the repositories always fit into the first bunch. I should have a fix
> up shortly.

Hi Baptiste, I think I solved the problem, please give it a try and let
me know if you see all of your repositories.
-Paul

Re: [Doxygen-users] Looking for beta testers of a Doxygen GitHub integration

[Paul N. <pa...@pa...>]

Unfortunately, organizations are not currently supported by the app. So
GitHub should not be asking you for permissions to access your
organizations, it should only be asking for access to your email and
adding repository hooks to your public repositories. However, I am
currently adding support for organizations, and will require access to
them. Unfortunatly, their current api does not allow for fine grain
control of the permissions. Although it sounds like GitHub is moving in
that direction, so this might work for you in the future.

-Paul


On Thu, Jan 7, 2016, at 07:55 PM, Sparr wrote:
> I want to give this a try, but apparently GitHub won't let me give
> your app permission to access just one of the organizations I'm part
> of. That's a deal breaker for me; not that I don't trust your app, but
> I don't give any access to some organizations.
>
> On Tue, Jan 5, 2016 at 5:56 PM, Paul Novotny <pa...@pa...> wrote:
>> Hello,
>>
>>
I put together a GitHub integration for generating and hosting Doxygen
>>
docs for your public GitHub repositories. Consider this an early
>>
prototype, but I would like to get some testers and feedback. Just go
>>
to:
>>
>> https://codedocs.xyz/
>>
>>
You should see a list of your public repositories. Then enable the
>>
repositories you want Doxygen generated for. A GitHub hook is added, so
>>
the documentation is rebuilt every time you push changes to GitHub. You
>>
can add badges to your README.md (like Coverity, Travis-CI, etc) that
>>
point to the documentation that is hosted on codedocs.xyz. For example,
>>
look at my OpenSceneGraph and Doxygen forks:
>>
>> https://github.com/paulnovo/osg https://github.com/paulnovo/doxygen
>>
>>
I added the "code: documented" badges to the README.md that point to the
>>
latest Doxgyen documentation:
>>
>> https://codedocs.xyz/paulnovo/osg/
>> https://codedocs.xyz/paulnovo/doxygen/
>>
>>
Let me know what you think. Hopefully this will be useful for Doxygen
>>
users.
>>
>>
-Paul
>>
>>
--------------------------------------------------------------------
----------
>>
_______________________________________________
>>
Doxygen-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: [Doxygen-users] Looking for beta testers of a Doxygen GitHub integration

[Sparr <sp...@gm...>]

I want to give this a try, but apparently GitHub won't let me give your app
permission to access just one of the organizations I'm part of. That's a
deal breaker for me; not that I don't trust your app, but I don't give any
access to some organizations.

On Tue, Jan 5, 2016 at 5:56 PM, Paul Novotny <pa...@pa...> wrote:

> Hello,
>
> I put together a GitHub integration for generating and hosting Doxygen
> docs for your public GitHub repositories. Consider this an early
> prototype, but I would like to get some testers and feedback. Just go
> to:
>
>   https://codedocs.xyz/
>
> You should see a list of your public repositories. Then enable the
> repositories you want Doxygen generated for. A GitHub hook is added, so
> the documentation is rebuilt every time you push changes to GitHub. You
> can add badges to your README.md (like Coverity, Travis-CI, etc) that
> point to the documentation that is hosted on codedocs.xyz. For example,
> look at my OpenSceneGraph and Doxygen forks:
>
>   https://github.com/paulnovo/osg
>   https://github.com/paulnovo/doxygen
>
> I added the "code: documented" badges to the README.md that point to the
> latest Doxgyen documentation:
>
>   https://codedocs.xyz/paulnovo/osg/
>   https://codedocs.xyz/paulnovo/doxygen/
>
> Let me know what you think. Hopefully this will be useful for Doxygen
> users.
>
> -Paul
>
>
> ------------------------------------------------------------------------------
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>