doxygen-users — List for users of doxygen

Re: [Doxygen-users] in PDFs - change url color, font of explicit html href, etc. ?

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

Well, I tried putting my customization into the custom_header.tex file instead of the custom_doxygen.sty file, and Doxygen successfully picks up my settings for link colors, border colors, and PDF properties (such as initial settings, title, and author).
So a great deal of success :-).
But the expected usage of the “\urlstyle” command to change the font for links to websites and external files (vs. the links to sections/modules/entities that are within the resultant PDF) from courier (which ends up as “\tt” in the Doxygen-produced .tex files) doesn’t have any effect.
There’s no warning or error thrown by MiKTex/TeXworks, so the correct package(s) – hyperref, which uses urlstyle; and the ulr package that hyperref uses – seem to be correctly used (via \usepackage). But whether I set “\urlstyle{same}”, “\urlstyle{sf}”, or even “\urlstyle{Arial}”, the links to websites and external files stubbornly remain in code/courier/tt font.
Any suggestions?
Thanks so much,
-Monique

Re: [Doxygen-users] in PDFs - change url color, font of explicit html href, etc. ?

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

> I found that in addition to assigning the custom_doxygen.sty file to the Doxyfile LATEX_EXTRA_STYLESHEET option, it’s also necessary to assign it (minus the .sty extension) to the EXTRA_PACKAGES option.
No, that wasn’t it. I was accidentally looking at the wrong PDF, which had been produced by my manually-edited refman.tex file. So I still don’t know how to get Doxygen to add the custom commands to the refman.tex file...
-Monique

Re: [Doxygen-users] in PDFs - change url color, font of explicit html href, etc. ?

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

> I’ve created a custom_doxygen.sty file, and assigned it to the LATEX_EXTRA_STYLESHEET. I assume that it’s being picked up by Doxygen ...
Turns out that my custom_doxygen.sty file was NOT being picked up by Doxygen. With the help of this Stack Overflow Q&A, http://stackoverflow.com/questions/1977596/how-can-i-change-the-margins-on-a-pdf-document-created-by-doxygen, I found that in addition to assigning the custom_doxygen.sty file to the Doxyfile LATEX_EXTRA_STYLESHEET option, it’s also necessary to assign it (minus the .sty extension) to the EXTRA_PACKAGES option.
So now I know how to effect changes, and the work becomes figuring out the appropriate LaTeX packages to use and their options/arguments. Still lots to deal with, but now the customization can proceed :-).
-Monique
 

Re: [Doxygen-users] placing the filename in the documentation

[Alan <ala...@ya...>]

Robertson, Jeffrey E  (US) wrote
> Hi,
> 
> Is there a way to get the current filename for placement in a
> documentation block?  For example in file test_it.h, I want the following
> comment block
> 
> /// The name of this file is $FILENAME.
> 
> which when converted to documentation becomes:
> 
> The name of this file is test_it.h.

I asked essentially the same question on Stack Overflow four days ago:  how
to create a Doxygen link to the same file
<http://stackoverflow.com/questions/38513580/how-to-create-a-doxygen-link-to-the-same-file>  

No answers yet. The question has been viewed 18 times.



--
View this message in context: http://doxygen.10944.n7.nabble.com/placing-the-filename-in-the-documentation-tp7665p7675.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] in PDFs - change url color, font of explicit html href, etc. ?

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

Hello, Doxygen users,

I’m using Doxygen 1.8.10 (on Windows) to generate LaTeX files, and MiKTex 2.9 to generate a PDF. The PDF is functional, but not very pretty. I’ve figured out how to customize the title page (I added graphics and non-default text) and how to get the images into the PDF.

1. But... how do I change the styling for things such as the color of URLs (which are just text in the Doxygen comments, and then Doxygen turns them into \href items)?

**** I believe I need to change something in the hyperref package’s config or what Doxygen writes to the .tex files, but I’m not sure which approach is right, nor how to do either one...

I’ve created a custom_doxygen.sty file, and assigned it to the LATEX_EXTRA_STYLESHEET. I assume that it’s being picked up by Doxygen because Doxygen is successfully picking up my custom LATEX_HEADER file, which is in the same directory as the custom_doxygen.sty file. But what I don’t know is what to put into the custom_doxygen.sty file?

If I run everything as default (that is, no LATEX_EXTRA_STYLESHEET), the following code gets written to the refman.tex file:

% Hyperlinks (required, but should be loaded last)
\usepackage{ifpdf}
\ifpdf
  \usepackage[pdftex,pagebackref=true]{hyperref}
\else
  \usepackage[ps2pdf,pagebackref=true]{hyperref}
\fi
\hypersetup{%
  colorlinks=true,%
  linkcolor=blue,%
  citecolor=blue,%
  unicode%
}

And what I need is for the “urlcolor” to also be blue (its default in the hyperref package is magenta—an odd choice for sure).

I tried just basically copying what was in the refman.tex file to the custom_doxygen.sty file (and making sure that the custom_doxygen.sty file *is* assigned to the LATEX_EXTRA_STYLESHEET setting in my Doxyfile) and adding a “urlcolor=blue,%” to the setup section, but there’s no change in the output.

2. And a similar issue to fix: links that are in the Doxygen comments as explicit <a href> entities are appearing in the PDF as light blue stretched out courier font. I’ve no idea what is setting this styling, nor how to change it?

Thanks for your help to figure this out!
-Monique

[Doxygen-users] custom .joboptions for PDF output ?

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

Hello, Doxygen users,

Although my previous message concerned creating higher-res EPS files, I actually don’t think that that’s the problem/cause of the blurry images in the final PDF. Instead, I believe that what I need to do is use a custom PDF .joboptions file, or otherwise customize the settings, that MiKTeX/TeXworks uses to produce the PDF.

(I say this because the final PDF looks the same regardless of whether the EPS image is 100 KB, 860 KB, or even 1553 KB—this last size was the result of using maximum image quality .joboptions when I print the Visio image to PDF, and then use Illustrator to save the image PDF as an EPS file.)

I’ve started down the path of figuring out how to change the distiller settings that MiKTeX uses to create the PDF, and think perhaps the key is either of the following files:
* \ProgramFiles\MiKTeX 2.9\tex\latex\distiller.cfg
* \ProgramFiles\MiKTex 2.9\pdftex\config\pdftex.cfg

Has anyone already customized their LaTeX->PDF distiller settings? If so, how did you do it?

Thanks,
-Monique

Re: [Doxygen-users] quality VSD (Visio) to EPS conversion ?

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

Finishing the middle paragraph, below.

From: Monique Semp 
Sent: Friday, July 22, 2016 11:32 AM
To: doxygen-users 
Subject: [Doxygen-users] quality VSD (Visio) to EPS conversion ?

Hello, Doxygen users,

Googling shows that there are many paths to converting a Visio VSD file (yes, VSD, not VSDX, because I’m still using my old Visio 2007) to EPS, which I want to do to get images into a PDF that’s produced by Doxygen-generated LaTeX output that I input to TeXworks.

I’m assuming that with so many methods to do this, the results will range from excellent to poor, in terms of good quality/hi-res images. (Using Illustrator to convert from the Visio-output PNG file to an EPS file results in rather blurry images. There are many options in Illustrator, so perhaps it’s fixable. But I’d assume that it’s better [edit here] to start with the source VSD file than the converted PNG file anyway.)

So, is anyone already doing this VSD->EPS conversion with good results? If so, please share your method.

Hoping to save some experimentation time,
-Monique

[Doxygen-users] quality VSD (Visio) to EPS conversion ?

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

Hello, Doxygen users,

Googling shows that there are many paths to converting a Visio VSD file (yes, VSD, not VSDX, because I’m still using my old Visio 2007) to EPS, which I want to do to get images into a PDF that’s produced by Doxygen-generated LaTeX output that I input to TeXworks.

I’m assuming that with so many methods to do this, the results will range from excellent to poor, in terms of good quality/hi-res images. (Using Illustrator to convert from the Visio-output PNG file to an EPS file results in rather blurry images. There are many options in Illustrator, so perhaps it’s fixable. But I’d assume that it’s better 

So, is anyone already doing this VSD->EPS conversion with good results? If so, please share your method.

Hoping to save some experimentation time,
-Monique

[Doxygen-users] Relative Paths in configuration files

[Fabian N. <fab...@sc...>]

Hi everyone,

I want to specify an HTML_EXTRA_STYLESHEET in my config file that is in
the same directory as the config file itself.

However setting HTML_EXTRA_STYLESHEET  = ./stylesheet_extra.css only
works if doxygen is called in that very directory.
If doxygen is called in another directory, the css file isn't found. But
I want my colleagues to be able to call doxygen from whereever they like...

This is obviously because doxygen interprets the path relative to the
execution directory, but is there any way to make it interpret relative
paths relative to the config file?
Or is there any other way to achive what I need?

Regards,
Fabian.

Re: [Doxygen-users] C++ Anonymous Structure Identification (XML Output)

[Richard D. <Ri...@Da...>]

On 7/15/16 7:27 PM, CareyG wrote:
> I have created a simple union as follows:
>
> #ifndef _ANONUNION_H
> #define _ANONUNION_H
>
> #ifdef __cplusplus
> ///@brief Anonymous Union example.
> namespace AnonUnion
> {
> #endif
>
> 	///@brief Create a typename for our union.
> 	typedef union {
> 		///@brief A short followed by two characters.
> 		struct {
> 			short s;	///<A short.
> 			char ch1;	///&lt;A single character.
> 			char ch2;	///&lt;Another character.
> 		};
> 		
> 		///@brief Structure as an unsigned long.
> 		unsigned long ul;
> 	} Example;
> #ifdef __cplusplus
> }
> #endif
>
> #endif
>
> When I process this file, called AnonUnion.h I get the usual output files.
> In particular, the index file looks like:
<snipped>
> What I would like to know is how to identify that s, ch1 and ch2 are part of
> the anonymous structure and that ul1 and the anonymous structure are part of
> the union.
>
> I need to know this information to reconstruct the parsed input as part of a
> documentation package I am creating using an automated tool.
>
> I noticed that several other people have had similar questions over the
> years but none of them had a satisfactory answer that enables me to solve
> this problem.
>
> Thank you.
>
> Carey
I don't see any mention of the anonymous struct in the xml, which might 
not be that surprising as doxygen doesn't have anything to say about 
this struct since it is totally anonymous.

You probably don't want to give it a member name, as that would require 
a lot of changes in the code, but perhaps if you gave it a struct tag, 
you might get doxygen to note its existence, and that shouldn't change 
how you use it.

-- 
Richard Damon

[Doxygen-users] C++ Anonymous Structure Identification (XML Output)

[CareyG <car...@ou...>]

I have created a simple union as follows:

#ifndef _ANONUNION_H
#define _ANONUNION_H

#ifdef __cplusplus
///@brief Anonymous Union example.
namespace AnonUnion
{
#endif

	///@brief Create a typename for our union.
	typedef union {
		///@brief A short followed by two characters.
		struct {
			short s;	///<A short.
			char ch1;	///&lt;A single character.
			char ch2;	///&lt;Another character.
		};
		
		///@brief Structure as an unsigned long.
		unsigned long ul;
	} Example;
#ifdef __cplusplus
}
#endif

#endif

When I process this file, called AnonUnion.h I get the usual output files. 
In particular, the index file looks like:
&lt;?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygenindex xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="index.xsd" version="1.8.11">
  <compound refid="union_anon_union_1_1_example"
kind="union"><name>AnonUnion::Example</name>
    <member
refid="union_anon_union_1_1_example_1a0d2cb966d6a40aa220fa172c2fb3562b"
kind="variable"><name>s</name></member>
    <member
refid="union_anon_union_1_1_example_1a25196dd24281a5d62f0cb98b2054a5c5"
kind="variable"><name>ch1</name></member>
    <member
refid="union_anon_union_1_1_example_1a43b624de604452d595fe32f6113ff7e5"
kind="variable"><name>ch2</name></member>
    <member
refid="union_anon_union_1_1_example_1a10a0a523db652b68d9b92073ad910ec2"
kind="variable"><name>@1</name></member>
    <member
refid="union_anon_union_1_1_example_1ae939d9fba73319ca43bd898ae3427cd5"
kind="variable"><name>ul</name></member>
  </compound>
  <compound refid="namespace_anon_union"
kind="namespace"><name>AnonUnion</name>
  </compound>
  <compound refid="_anon_union_8h" kind="file"><name>AnonUnion.h</name>
  </compound>
  <compound refid="dir_d44c64559bbebec7f509842c48db8b23"
kind="dir"><name>include</name>
  </compound>
</doxygenindex>

And the compound file looks like:

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.11">
  <compounddef id="union_anon_union_1_1_example" kind="union" language="C++"
prot="public">
    <compoundname>AnonUnion::Example</compoundname>
    <includes refid="_anon_union_8h" local="no">AnonUnion.h</includes>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable"
id="union_anon_union_1_1_example_1a0d2cb966d6a40aa220fa172c2fb3562b"
prot="public" static="no" mutable="no">
        <type>short</type>
        <definition>short AnonUnion::Example::s</definition>
        <argsstring></argsstring>
        <name>s</name>
        <briefdescription>
<para>A short. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="include/AnonUnion.h" line="15" column="1"
bodyfile="include/AnonUnion.h" bodystart="15" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable"
id="union_anon_union_1_1_example_1a25196dd24281a5d62f0cb98b2054a5c5"
prot="public" static="no" mutable="no">
        <type>char</type>
        <definition>char AnonUnion::Example::ch1</definition>
        <argsstring></argsstring>
        <name>ch1</name>
        <briefdescription>
<para>A single character. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="include/AnonUnion.h" line="16" column="1"
bodyfile="include/AnonUnion.h" bodystart="16" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable"
id="union_anon_union_1_1_example_1a43b624de604452d595fe32f6113ff7e5"
prot="public" static="no" mutable="no">
        <type>char</type>
        <definition>char AnonUnion::Example::ch2</definition>
        <argsstring></argsstring>
        <name>ch2</name>
        <briefdescription>
<para>Another character. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="include/AnonUnion.h" line="17" column="1"
bodyfile="include/AnonUnion.h" bodystart="17" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable"
id="union_anon_union_1_1_example_1a10a0a523db652b68d9b92073ad910ec2"
prot="public" static="no" mutable="no">
        <type>struct AnonUnion::Example::@0</type>
        <definition>struct AnonUnion::Example::@0
AnonUnion::Example::@1</definition>
        <argsstring></argsstring>
        <name>@1</name>
        <briefdescription>
<para>A short followed by two characters. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="include/AnonUnion.h" line="18" column="1"/>
      </memberdef>
      <memberdef kind="variable"
id="union_anon_union_1_1_example_1ae939d9fba73319ca43bd898ae3427cd5"
prot="public" static="no" mutable="no">
        <type>unsigned long</type>
        <definition>unsigned long AnonUnion::Example::ul</definition>
        <argsstring></argsstring>
        <name>ul</name>
        <briefdescription>
<para>Structure as an unsigned long. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="include/AnonUnion.h" line="21" column="1"
bodyfile="include/AnonUnion.h" bodystart="21" bodyend="-1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Create a typename for our union. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="1">
        <label>AnonUnion::Example</label>
        <link refid="union_anon_union_1_1_example"/>
      </node>
    </collaborationgraph>
    <location file="include/AnonUnion.h" line="12" column="1"
bodyfile="include/AnonUnion.h" bodystart="12" bodyend="22"/>
    <listofallmembers>
      <member
refid="union_anon_union_1_1_example_1a25196dd24281a5d62f0cb98b2054a5c5"
prot="public"
virt="non-virtual"><scope>AnonUnion::Example</scope><name>ch1</name></member>
      <member
refid="union_anon_union_1_1_example_1a43b624de604452d595fe32f6113ff7e5"
prot="public"
virt="non-virtual"><scope>AnonUnion::Example</scope><name>ch2</name></member>
      <member
refid="union_anon_union_1_1_example_1a0d2cb966d6a40aa220fa172c2fb3562b"
prot="public"
virt="non-virtual"><scope>AnonUnion::Example</scope><name>s</name></member>
      <member
refid="union_anon_union_1_1_example_1ae939d9fba73319ca43bd898ae3427cd5"
prot="public"
virt="non-virtual"><scope>AnonUnion::Example</scope><name>ul</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>

What I would like to know is how to identify that s, ch1 and ch2 are part of
the anonymous structure and that ul1 and the anonymous structure are part of
the union.

I need to know this information to reconstruct the parsed input as part of a
documentation package I am creating using an automated tool.

I noticed that several other people have had similar questions over the
years but none of them had a satisfactory answer that enables me to solve
this problem.

Thank you.

Carey




--
View this message in context: http://doxygen.10944.n7.nabble.com/C-Anonymous-Structure-Identification-XML-Output-tp7668.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] Core dump parse D in Doxygen 1.8.11

[Nick M. <nic...@gm...>]

Hey Dimitri:

I have not posted here in a long, long time, but I hope I am doing
this right.  I am trying to help my friend who is having trouble with
using Doxygen with D for the first time.  He's using the latest DMD
and so the latest D language features, I don't know if that is the
source of the problem. I created a Doxyfile for him, edited it to
include undocumented members and some other obvious changes, and then
ran doxygen and it crashes with a segfault.  Here's some info to help
maybe lead to the problem, although you can follow up with me in
person if you need more specific details or the actual code.

If I comment in the line:  loadedScenes[SceneEnum.TITLESCENE]   = new
TitleScene(); this causes the segfault.  I ran in in gdb and did a
backtrace, which is included.  There is a snippit from scene.d
included.

Nick


Doxygen 1.8.11 on Fedora 24

...
...
Parsing file /home/nick/hz/src/scene/scene.d...

Program received signal SIGSEGV, Segmentation fault.
0x00005555558167e2 in QCString::operator+=(char const*) ()
(gdb) backtrace
#0  0x00005555558167e2 in QCString::operator+=(char const*) ()
#1  0x0000555555a9e13f in scannerYYlex() ()
#2  0x0000555555aa97f9 in CLanguageScanner::parseInput(char const*,
char const*, Entry*, bool, QStrList&) ()
#3  0x00005555557dc8d4 in parseFiles(Entry*, EntryNav*) ()
#4  0x000055555580efe4 in parseInput() ()
#5  0x00005555557bf7b9 in main ()

immutable enum SceneEnum {
   TITLESCENE,
   SELECTSCENE,
   LOADSCENE,
   PLAYINGSCENE,
}

private {
   GameScene[SceneEnum] loadedScenes;
   SceneEnum activeScene;
}

shared static this() {
/* Commenting this back in causes a coredump in Doxygen
   loadedScenes[SceneEnum.TITLESCENE]   = new TitleScene();
   loadedScenes[SceneEnum.SELECTSCENE]  = new SelectScene();
   loadedScenes[SceneEnum.LOADSCENE]    = new LoadScene();
   loadedScenes[SceneEnum.PLAYINGSCENE] = new PlayingScene();
   activeScene = SceneEnum.TITLESCENE;
   loadedScenes[activeScene].enter();
*/
}


-- 
Nick MacDonald
Nic...@gm...

[Doxygen-users] placing the filename in the documentation

[Robertson, J. E (US) <jef...@ba...>]

Hi,

Is there a way to get the current filename for placement in a documentation block.  For example if file test_it.h  I want the following comment block


/// The name of this file is $FILENAME.

Which when converted to documentation becomes:

The name of this file is test_it.h.

Re: [Doxygen-users] documenting C structure

[Brian H. <bhe...@pi...>]

I have an anecdote related to this.  In my experience, a comment block delineated by /**… */with more than two asterisks at the start is ignored by Doxygen.  When I adopted doxygen markup into our project at work, we then had two competing comment block styles, and I ended up having to put a space after the second * to then have a longer line of *s, like so:

/***************
** \brief Doxygen doesn’t see this one the way we used to do it
***************/

/** ************
** \brief But it does see this one with the space in there
***************/

Note the space after the second * in the second example.

HTH; YMMV.
-Brian

From: MURESIANU Philippe [mailto:P.M...@ob...]
Sent: Friday, July 08, 2016 4:47 AM
To: Albert <alb...@gm...>
Cc: dox...@li...
Subject: Re: [Doxygen-users] documenting C structure

Hi Albert,

Here is an example of the code and doxygen comments:

If I do the way below, ‘S_MyStruct’ is not found by Doxygen:

mySource.c:

/****************
\struct S_MyStruct
\brief  blablabla
****************/
typedef struct {
unsigned short  W_len;
unsigned char    B_nb;
unsigned char    Ba_Buf[10];
} S_MyStruct;

/****************
\brief  it’s my function that uses \ref S_MyStruct
****************/
void myFunction()
{
…
}

Doxygen reports in warnings.txt:
mySource.c: 50: warning: unable to resolve reference to ‘S_MyStruct’ for \ref command


BUT, if I put the structure declaration in “mySource.h”, ‘S_MyStruct’ is found by Doxygen.

Doxygen version: 1.8.9.1

Thanks.

Regards,

Philippe



De : Albert [mailto:alb...@gm...]
Envoyé : jeudi 7 juillet 2016 19:26
À : MURESIANU Philippe
Cc : dox...@li...<mailto:dox...@li...>
Objet : Re: [Doxygen-users] documenting C structure

Please add some code and the version of doxygen you used, so we can see what you tried and it is easier to give an advise.
Albert

On Thu, Jul 7, 2016 at 11:33 AM, MURESIANU Philippe <P.M...@ob...<mailto:P.M...@ob...>> wrote:
Hi,

When I declare a structure in my .c source file, the reference of the structure is not found by Doxygen.
If I declare it in my header file (for test purpose), Doxygen finds the reference.
I declare my structure in .c source on purpose and I can’t declare it in the header file.
How can I fix my issue and make Doxygen finds the reference of this structure ?

Thanks.

Regards,

Philippe

------------------------------------------------------------------------------
Attend Shape: An AT&T Tech Expo July 15-16. Meet us at AT&T Park in San
Francisco, CA to explore cutting-edge tech and listen to tech luminaries
present their vision of the future. This family event has something for
everyone, including kids. Get more information and register today.
http://sdm.link/attshape
_______________________________________________
Doxygen-users mailing list
Dox...@li...<mailto:Dox...@li...>
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: [Doxygen-users] documenting C structure

[MURESIANU P. <P.M...@ob...>]

Hi Albert,

Here is an example of the code and doxygen comments:

If I do the way below, ‘S_MyStruct’ is not found by Doxygen:

mySource.c:

/****************
\struct S_MyStruct
\brief  blablabla
****************/
typedef struct {
unsigned short  W_len;
unsigned char    B_nb;
unsigned char    Ba_Buf[10];
} S_MyStruct;

/****************
\brief  it’s my function that uses \ref S_MyStruct
****************/
void myFunction()
{
…
}

Doxygen reports in warnings.txt:
mySource.c: 50: warning: unable to resolve reference to ‘S_MyStruct’ for \ref command


BUT, if I put the structure declaration in “mySource.h”, ‘S_MyStruct’ is found by Doxygen.

Doxygen version: 1.8.9.1

Thanks.

Regards,

Philippe



De : Albert [mailto:alb...@gm...]
Envoyé : jeudi 7 juillet 2016 19:26
À : MURESIANU Philippe
Cc : dox...@li...
Objet : Re: [Doxygen-users] documenting C structure

Please add some code and the version of doxygen you used, so we can see what you tried and it is easier to give an advise.
Albert

On Thu, Jul 7, 2016 at 11:33 AM, MURESIANU Philippe <P.M...@ob...<mailto:P.M...@ob...>> wrote:
Hi,

When I declare a structure in my .c source file, the reference of the structure is not found by Doxygen.
If I declare it in my header file (for test purpose), Doxygen finds the reference.
I declare my structure in .c source on purpose and I can’t declare it in the header file.
How can I fix my issue and make Doxygen finds the reference of this structure ?

Thanks.

Regards,

Philippe

------------------------------------------------------------------------------
Attend Shape: An AT&T Tech Expo July 15-16. Meet us at AT&T Park in San
Francisco, CA to explore cutting-edge tech and listen to tech luminaries
present their vision of the future. This family event has something for
everyone, including kids. Get more information and register today.
http://sdm.link/attshape
_______________________________________________
Doxygen-users mailing list
Dox...@li...<mailto:Dox...@li...>
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: [Doxygen-users] documenting C structure

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

Please add some code and the version of doxygen you used, so we can see
what you tried and it is easier to give an advise.

Albert

On Thu, Jul 7, 2016 at 11:33 AM, MURESIANU Philippe <
P.M...@ob...> wrote:

> Hi,
>
>
>
> When I declare a structure in my .c source file, the reference of the
> structure is not found by Doxygen.
>
> If I declare it in my header file (for test purpose), Doxygen finds the
> reference.
>
> I declare my structure in .c source on purpose and I can’t declare it in
> the header file.
>
> How can I fix my issue and make Doxygen finds the reference of this
> structure ?
>
>
>
> Thanks.
>
>
>
> Regards,
>
>
>
> Philippe
>
>
> ------------------------------------------------------------------------------
> Attend Shape: An AT&T Tech Expo July 15-16. Meet us at AT&T Park in San
> Francisco, CA to explore cutting-edge tech and listen to tech luminaries
> present their vision of the future. This family event has something for
> everyone, including kids. Get more information and register today.
> http://sdm.link/attshape
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] documenting C structure

[MURESIANU P. <P.M...@ob...>]

Hi,

When I declare a structure in my .c source file, the reference of the structure is not found by Doxygen.
If I declare it in my header file (for test purpose), Doxygen finds the reference.
I declare my structure in .c source on purpose and I can't declare it in the header file.
How can I fix my issue and make Doxygen finds the reference of this structure ?

Thanks.

Regards,

Philippe

Re: [Doxygen-users] Pages in Doxygen 1.8.11

[Fabian N. <fab...@sc...>]

Hi,

thanks, it's working again.

Best,
Fabian.

* From: Sebastien Loriot (Geometryfactory) (slo...@gm...)
* To: Fabian Nick (fab...@sc...)
* Sent:  30.06.2016 at 11:39 +0200
* Subject: Re: [Doxygen-users] Pages in Doxygen 1.8.11
> Hi,
> 
> set
> EXTENSION_MAPPING      = dg=C++
> in your config file (replace C++ by your language)
> 
> Best,
> 
> Sebastien.
> 
> On 06/30/2016 10:46 AM, Fabian Nick wrote:
>> Hi everyone,
>>
>> we have various files in our project that we name *.dg that just contain
>> 'User Manual Pages' like
>>
>>> /*! \page gettingstarted Getting Started
>>>
>>> Getting Started
>>> ==============
>>> The first thing you will want to do is to read the @ref maininterfaces documentation.
>>>
>>> */
>>
>> At least up to Doxygen 1.8.7 that worked perfectly fine. We have the
>> path specified in INPUT and *.dg in FILE_PATTERNS.
>> The pages then appear in the left side bar of the html output.
>>
>> But with Doxygen 1.8.11, we do not see the pages any more. We can view
>> their source code by browsing through the 'files' list, but they don't
>> appear as actual pages any more.
>> >From Doxygen's output we see that it 'read', 'generated code' and
>> 'generated docs' for the *.dg files.
>>
>> Was there any change between 1.8.7 and 1.8.11 that we need to take into
>> account?
>>
>> Thanks,
>> Fabian.
>>
>> ------------------------------------------
>>
>> Fabian Nick
>>
>> Fraunhofer Institute for
>> Algorithms and Scientific Computing (SCAI)
>>
>> Schloss Birlinghoven
>> D-53754 Sankt Augustin, Germany
>>
>> Phone:  (+49 | 0) 2241 14-2139
>> fab...@sc...
>> http://www.scai.fraunhofer.de
>>
>> ------------------------------------------
>>
>>
>> ------------------------------------------------------------------------------
>> Attend Shape: An AT&T Tech Expo July 15-16. Meet us at AT&T Park in San
>> Francisco, CA to explore cutting-edge tech and listen to tech luminaries
>> present their vision of the future. This family event has something for
>> everyone, including kids. Get more information and register today.
>> http://sdm.link/attshape
>> _______________________________________________
>> Doxygen-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
> 
> 
> ------------------------------------------------------------------------------
> Attend Shape: An AT&T Tech Expo July 15-16. Meet us at AT&T Park in San
> Francisco, CA to explore cutting-edge tech and listen to tech luminaries
> present their vision of the future. This family event has something for
> everyone, including kids. Get more information and register today.
> http://sdm.link/attshape
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
> 

Re: [Doxygen-users] Pages in Doxygen 1.8.11

[Sebastien L. (GeometryFactory) <slo...@gm...>]

Hi,

set
EXTENSION_MAPPING      = dg=C++
in your config file (replace C++ by your language)

Best,

Sebastien.

On 06/30/2016 10:46 AM, Fabian Nick wrote:
> Hi everyone,
>
> we have various files in our project that we name *.dg that just contain
> 'User Manual Pages' like
>
>> /*! \page gettingstarted Getting Started
>>
>> Getting Started
>> ==============
>> The first thing you will want to do is to read the @ref maininterfaces documentation.
>>
>> */
>
> At least up to Doxygen 1.8.7 that worked perfectly fine. We have the
> path specified in INPUT and *.dg in FILE_PATTERNS.
> The pages then appear in the left side bar of the html output.
>
> But with Doxygen 1.8.11, we do not see the pages any more. We can view
> their source code by browsing through the 'files' list, but they don't
> appear as actual pages any more.
>>From Doxygen's output we see that it 'read', 'generated code' and
> 'generated docs' for the *.dg files.
>
> Was there any change between 1.8.7 and 1.8.11 that we need to take into
> account?
>
> Thanks,
> Fabian.
>
> ------------------------------------------
>
> Fabian Nick
>
> Fraunhofer Institute for
> Algorithms and Scientific Computing (SCAI)
>
> Schloss Birlinghoven
> D-53754 Sankt Augustin, Germany
>
> Phone:  (+49 | 0) 2241 14-2139
> fab...@sc...
> http://www.scai.fraunhofer.de
>
> ------------------------------------------
>
>
> ------------------------------------------------------------------------------
> Attend Shape: An AT&T Tech Expo July 15-16. Meet us at AT&T Park in San
> Francisco, CA to explore cutting-edge tech and listen to tech luminaries
> present their vision of the future. This family event has something for
> everyone, including kids. Get more information and register today.
> http://sdm.link/attshape
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

[Doxygen-users] Pages in Doxygen 1.8.11

[Fabian N. <fab...@sc...>]

Hi everyone,

we have various files in our project that we name *.dg that just contain
'User Manual Pages' like

> /*! \page gettingstarted Getting Started
> 
> Getting Started
> ==============
> The first thing you will want to do is to read the @ref maininterfaces documentation.
> 
> */

At least up to Doxygen 1.8.7 that worked perfectly fine. We have the
path specified in INPUT and *.dg in FILE_PATTERNS.
The pages then appear in the left side bar of the html output.

But with Doxygen 1.8.11, we do not see the pages any more. We can view
their source code by browsing through the 'files' list, but they don't
appear as actual pages any more.
>From Doxygen's output we see that it 'read', 'generated code' and
'generated docs' for the *.dg files.

Was there any change between 1.8.7 and 1.8.11 that we need to take into
account?

Thanks,
Fabian.

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

Fabian Nick

Fraunhofer Institute for
Algorithms and Scientific Computing (SCAI)

Schloss Birlinghoven
D-53754 Sankt Augustin, Germany

Phone:  (+49 | 0) 2241 14-2139
fab...@sc...
http://www.scai.fraunhofer.de

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

Re: [Doxygen-users] Placing \page in custom command.

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

Jeffrey,

As far as I know the ALIAS commands cannot be nested. For the \n problem I
would advise to use the <br>.

Albert

On Tue, Jun 28, 2016 at 4:10 PM, Robertson, Jeffrey E (US) <
jef...@ba...> wrote:

> I am trying to add a list of items to a page.  I am using the fact that
> /page in different files get added to the same page.  I have the following
> ALIASES define
>
>
>
> ALIASES               += "index_page=\page index_page this is an index
> page"
>
> ALIASES               += "simple_ref{1}=- \subpage si_csci_\1 \"\1\" "
>
> ALIASES               += "add_to_index_page{1}=\index_page \n
> simple_ref{\1}
>
>
>
>
>
> If in my code I have the following everything works fine
>
>
>
> /// \index_page
>
> /// \simple_ref{os_utilities}
>
>
>
> But if I try an use the add_to_index_page nested complex command it does
> not work.
>
>
>
> /// \add_to_index_page{os_utilities}
>
>
>
> I think it has something to do with the \page.  If I change
> add_to_index_page to:
>
>
>
> ALIASES               += "add_to_index_page{1}=\index_page \n
> simple_ref_x{\1}
>
>
>
> I would expect and error (simple_ref_x does not exist) but I do not get
> one.  It seems \page is consuming everything.
>
>
>
>
>
> I also tried
>
>
>
> ALIASES               += "index_page=\page index_page this is an index
> page \n"
>
>
>
> This results in the following warnings
>
>
>
> OS_Interface.h:36: warning: Found unknown command `\_linebr'
>
>
> ------------------------------------------------------------------------------
> Attend Shape: An AT&T Tech Expo July 15-16. Meet us at AT&T Park in San
> Francisco, CA to explore cutting-edge tech and listen to tech luminaries
> present their vision of the future. This family event has something for
> everyone, including kids. Get more information and register today.
> http://sdm.link/attshape
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] Placing \page in custom command.

[Robertson, J. E (US) <jef...@ba...>]

I am trying to add a list of items to a page.  I am using the fact that /page in different files get added to the same page.  I have the following ALIASES define

ALIASES               += "index_page=\page index_page this is an index page"
ALIASES               += "simple_ref{1}=- \subpage si_csci_\1 \"\1\" "
ALIASES               += "add_to_index_page{1}=\index_page \n simple_ref{\1}


If in my code I have the following everything works fine

/// \index_page
/// \simple_ref{os_utilities}

But if I try an use the add_to_index_page nested complex command it does not work.

/// \add_to_index_page{os_utilities}

I think it has something to do with the \page.  If I change add_to_index_page to:

ALIASES               += "add_to_index_page{1}=\index_page \n simple_ref_x{\1}

I would expect and error (simple_ref_x does not exist) but I do not get one.  It seems \page is consuming everything.


I also tried

ALIASES               += "index_page=\page index_page this is an index page \n"

This results in the following warnings

OS_Interface.h:36: warning: Found unknown command `\_linebr'

Re: [Doxygen-users] Q: possible to create custom special pages?

[Albrecht D. <alb...@ar...>]

Am 24.06.16 19:41 schrieb(en) Albert:
> Please look in the manual at \xrefitem or search the internet for some examples.

Ouch.  Looks as if I didn't read the right section of the manual.  Sorry for the noise!

Monique, thanks a lot for your excellent example - works perfectly for me, exactly what I need! :-)

Sorry again,
Albrecht.

Re: [Doxygen-users] hard to search - the archives on sourceforge...

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

Monique,

It is indeed hard to search but quite often I have quite good success with
google (not only for doxygen) on stack exchange buy giving as first word
stack followed by some keywords.

Albert

On Fri, Jun 24, 2016 at 7:56 PM, Monique Semp <mon...@ea...>
wrote:

> > This question has popped up multiple times on e.g. this forum and on
> stackexchange.
> Yes, but... I find it very (very) hard to use the archives on sourceforge.
> Unlike the archives of many other lists I’ve subscribed to, I haven’t found
> a way to search for a topic and then display all a given message’s replies
> in a typical threaded view. Clicking on individual messages often result in
> a display with the message repeated at least twice, but no links to the
> previous or next messages in a thread.
>
> It’s been a long time since the list moved to sourceforge, but I believe
> that the archives were much easier to search before that.
>
> But occasionally when I click a message, I do see several responses. I
> just have no idea when it’ll “work” and when I have to keep going to the
> search page and searching for ever-more specific things to try to get the
> display to show me all a thread’s messages.
>
> Perhaps I’m doing something wrong, or there’s a setting I haven’t found?
>
> -Monique
>
>
>
> ------------------------------------------------------------------------------
> Attend Shape: An AT&T Tech Expo July 15-16. Meet us at AT&T Park in San
> Francisco, CA to explore cutting-edge tech and listen to tech luminaries
> present their vision of the future. This family event has something for
> everyone, including kids. Get more information and register today.
> http://sdm.link/attshape
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] hard to search - the archives on sourceforge...

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

> This question has popped up multiple times on e.g. this forum and on stackexchange.

Yes, but... I find it very (very) hard to use the archives on sourceforge. Unlike the archives of many other lists I’ve subscribed to, I haven’t found a way to search for a topic and then display all a given message’s replies in a typical threaded view. Clicking on individual messages often result in a display with the message repeated at least twice, but no links to the previous or next messages in a thread.
It’s been a long time since the list moved to sourceforge, but I believe that the archives were much easier to search before that.
But occasionally when I click a message, I do see several responses. I just have no idea when it’ll “work” and when I have to keep going to the search page and searching for ever-more specific things to try to get the display to show me all a thread’s messages.
Perhaps I’m doing something wrong, or there’s a setting I haven’t found?
-Monique