doxygen-users — List for users of doxygen

[Doxygen-users] External documentation links

[Mark <dox...@er...>]

I’m experimenting with TAG files and external links and have a couple of questions.

1. Is it possible to disambiguate links in refs? I want to link to the index page of an external doc set for an API. I have

@subpage index

in the document doing the referencing. It is linking back to itself ‘cos it is also named index.

1a. If not, how can I tell Doxygen to use something other than “index” for the starting page when generating the external API doc?

2. Is there some way to reference an external page at the page level rather than subpage? If I try

@page externalref

Nothing appears. Only if I use

@subpage externalref

do I get a usable link.

The documentation for using tags is a joke. It stops at the point where it's told you how to get doxygen to find the tags file.

Regards

    -Mark

Re: [Doxygen-users] doxygen message I don't understand

[Jakob v. B. <jak...@gm...>]

Hej,

AFAIU Doxygen uses its entirely own parser - my guess is that this parser simply doesn’t support decltype() yet - the way to fix this, is to create a patch for Doxygen, and send it, so it finds its way to the next official release. For the time being though, I’d guess you can use the PREDEFINED option to ‘trick’ Doxygen into recognizing this as some type, see http://www.stack.nl/~dimitri/doxygen/manual/preprocessing.html <http://www.stack.nl/~dimitri/doxygen/manual/preprocessing.html>

Something straightforward like “decltype(expr)=AutoType” should expand to ‘AutoType’, getting rid of the error message. For the sake of not getting any errors, declaring an empty ‘AutoType’ somewhere should then to the trick. Not ideal, but pragmatic. (and not the worst trick I have ever seen to help out Doxygen a bit)

Sincerely,
Jakob


> On 19 Apr 2018, at 16:19, D. R. Evans <doc...@gm...> wrote:
> 
> Fabian Cenedese wrote on 04/19/2018 12:19 AM:
>> 
>>> /home/n7dr/projects/drlog/src/drlog_context.cpp:1615: warning: documented
>>> symbol `decltype' was not declared or defined.
>>> ----
>>> /*! \brief      Get names and values of sent exchange fields for a particular mode
>>>   \param  m   target mode
>>>   \return     the names and values of all the fields in the sent exchange
>>> when the mode is <i>m</i>
>>> */
>>> const decltype(drlog_context::_sent_exchange)
>>> drlog_context::sent_exchange(const MODE m)
>>> ----
>>> I don't understand what doxygen is complaining about. It looks fine to me, and
>>> there is no problem compiling. So how do I get rid of the message from doxygen?
>> 
>> It's probably thinking that decltype is a function as the line
>> looks like a function declaration. If it is a macro then you
>> should give doxygen the macro definition or maybe enable
>> the macro expansion in the config file.
> 
> I am afraid that I don't understand what point you are trying to make. The
> line *is* a function declaration; the return type for the function is:
>  const decltype(drlog_context::_sent_exchange)
> which seems to be what doxygen is complaining about for some reason, even
> though it's a perfectly legitimate return type (and the compiler accepts it,
> as it should).
> 
> There are no macros involved at all.
> 
>  Doc
> 
> -- 
> Web:  http://enginehousebooks.com/drevans <http://enginehousebooks.com/drevans>
> 
> ------------------------------------------------------------------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot_______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: [Doxygen-users] doxygen message I don't understand

[D. R. E. <doc...@gm...>]

Fabian Cenedese wrote on 04/19/2018 12:19 AM:
> 
>> /home/n7dr/projects/drlog/src/drlog_context.cpp:1615: warning: documented
>> symbol `decltype' was not declared or defined.
>> ----
>> /*! \brief      Get names and values of sent exchange fields for a particular mode
>>    \param  m   target mode
>>    \return     the names and values of all the fields in the sent exchange
>> when the mode is <i>m</i>
>> */
>> const decltype(drlog_context::_sent_exchange)
>> drlog_context::sent_exchange(const MODE m)
>> ----
>> I don't understand what doxygen is complaining about. It looks fine to me, and
>> there is no problem compiling. So how do I get rid of the message from doxygen?
> 
> It's probably thinking that decltype is a function as the line
> looks like a function declaration. If it is a macro then you
> should give doxygen the macro definition or maybe enable
> the macro expansion in the config file.

I am afraid that I don't understand what point you are trying to make. The
line *is* a function declaration; the return type for the function is:
  const decltype(drlog_context::_sent_exchange)
which seems to be what doxygen is complaining about for some reason, even
though it's a perfectly legitimate return type (and the compiler accepts it,
as it should).

There are no macros involved at all.

  Doc

-- 
Web:  http://enginehousebooks.com/drevans

Re: [Doxygen-users] doxygen message I don't understand

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

>/home/n7dr/projects/drlog/src/drlog_context.cpp:1615: warning: documented
>symbol `decltype' was not declared or defined.
>----
>/*! \brief      Get names and values of sent exchange fields for a particular mode
>    \param  m   target mode
>    \return     the names and values of all the fields in the sent exchange
>when the mode is <i>m</i>
>*/
>const decltype(drlog_context::_sent_exchange)
>drlog_context::sent_exchange(const MODE m)
>----
>I don't understand what doxygen is complaining about. It looks fine to me, and
>there is no problem compiling. So how do I get rid of the message from doxygen?

It's probably thinking that decltype is a function as the line
looks like a function declaration. If it is a macro then you
should give doxygen the macro definition or maybe enable
the macro expansion in the config file.

bye  Fabi

[Doxygen-users] doxygen message I don't understand

[D. R. E. <doc...@gm...>]

I am running debian stable.

doxygen is emitting this message:

----

/home/n7dr/projects/drlog/src/drlog_context.cpp:1615: warning: documented
symbol `decltype' was not declared or defined.

----

This is the relevant part of the source file:

----

/*! \brief      Get names and values of sent exchange fields for a particular mode
    \param  m   target mode
    \return     the names and values of all the fields in the sent exchange
when the mode is <i>m</i>
*/
const decltype(drlog_context::_sent_exchange)
drlog_context::sent_exchange(const MODE m)

----

I don't understand what doxygen is complaining about. It looks fine to me, and
there is no problem compiling. So how do I get rid of the message from doxygen?

  Doc

-- 
Web:  http://enginehousebooks.com/drevans

[Doxygen-users] Themes with Doxygen

[Steven A. <wan...@gm...>]

Hi, I have spent nearly two days trying to get any of the existing themes
out there that I have found (about 8 of them) to work with Doxygen.

I thought I had discovered that it may not be possible without compiling
Doxygen with some parameters to get this to work.

Anyone able to give me detailed directions?


This is the theme that I really want to use, but it doesn't seem to work.

https://github.com/nafSadh/doxygen-theme-metro

Very little is written about them and there are very few themes so it
appears.

Help is appreciated, and so isn't your time!

Regards,


Steven

[Doxygen-users] case-sensitive names in Fortran

[Jörg S. <joe...@tu...>]

Hi,

using Doxygen already for a couple of years, I happily acknowledge the steadily improving Fortran support. Great thanks to Dimitri and all other contributors!

Yet, I find difficult to arrange with the imperative conversion of names to lower case. I see the motivation that Fortran is a case insensitive language. Hence, the conversion is a reasonable default. However, it is common practice even in Fortran projects to use the case for better readability and transporting some meta-information. For example, constants could be written in upper-case, procedures and types (classes) in camel-case and ordinary variables in lower cases. While we enforce these conventions in our style guide, they are debilitated by the conversion to all lower-case. 

Given these observations, I wonder if there isn’t a switch which recovers a case-sensitive behavior for Fortran, similar to C or C++?
If not, I am curious if the development of such a feature planed for a future release.  


Best regards,
Jörg


--
PD Dr.-Ing. habil. Jörg Stiller
Privatdozent / senior lecturer

Technische Universität Dresden
Institut für Strömungsmechanik
01062 Dresden / GERMANY
Tel.: +49 351 463/38328
Fax: +49 351 463/38087
E-Mail:  joe...@tu... <mailto:joe...@tu...>
http://tu-dresden.de/Members/joerg.stiller <http://tu-dresden.de/Members/joerg.stiller>

[Doxygen-users] A doxygen plugin for visual studio

[<549...@qq...>]

Dear doxygen admin,


I make a relationship graph visualization plugin for Visual Studio based on doxygen.


Basically, the plugin uses doxygen to analyse solution, then users can explore the relationship between classes/functions/variables and build the graph they want.


Here is the link:
https://marketplace.visualstudio.com/items?itemName=YaobinOuyang.CodeAtlas#overview


If you like it, hopefully you can add a short introduction for my plugin to doxygen "extension" page, that is
http://www.stack.nl/~dimitri/doxygen/helpers.html . That will make my plugin more well known, also strengthen the power of doxygen.


Thank you!
Yiubun

[Doxygen-users] Doxygen 1.8.14: error while loading shared libraries: libclang.so.6: cannot open shared object file: No such file or directory

[Geoff A. <geo...@gm...>]

I downloaded the binary distribution of Doxygen 1.8.14 for Linux x86-64
(doxygen-1.8.14.linux.bin.tar.gz) from
http://www.stack.nl/~dimitri/doxygen/download.html and installed it as
follows on openSUSE 42.3 (x86_64):

 

(1) Expanded doxygen-1.8.14.linux.bin.tar.gz

(2) Changed directory to the expanded directory

(3) Ran "./configure --prefix /usr/local/doxygen-1.8.14" (without quotes)

(4) Ran "make install" (without quotes)

 

When I run "/usr/local/doxygen-1.8.14/bin/doxygen --version" (without
quotes), I get

 

   gdlxn@linux-6edc:~> /usr/local/doxygen-1.8.14/bin/doxygen --version

   /usr/local/doxygen-1.8.14/bin/doxygen: error while loading shared
libraries: libclang.so.6: cannot open shared object file: No such file or
directory

   gdlxn@linux-6edc:~> 

 

I have clang installed on my system (as RPM package
libclang-3.8.0-5.1.x86_64), but this only gives clang 3.8.  How can I
install Doxygen 1.8.14 on openSUSE 42.3 without having to compile it from
source?

 

Thanks,

Geoff Alexander

Re: [Doxygen-users] Doxygen: PROJECT_LOGO and LaTeX

[Joe B. <pub...@gm...>]

Thanks for the guidance.  The answer to your question is no...there's
no reference to mylogo.jpg in the TEX files.  I now have a better
understanding of Doxygen + LaTeX and how the custom header can be used
to achieve what I want.  In an attempt to help others here's my
solution to get a logo on the front page:

- Create an empty folder
- In the empty folder create a new Doxyfile with "doxygen -g"
- Create a new sample TEX header file in the same folder with "doxygen
-w latex header.tex doxygen.sty"
- Create a new image in the same folder, 150x50 pixels, called "mylogo.jpg"
- Edit Doxyfile
- Change PROJECT_LOGO to "PROJECT_LOGO = mylogo.jpg"
- Change LATEX_HEADER to "LATEX_HEADER = header.tex"
- Edit header.tex
- Find the line that says "{\Large Your title here}\\".  Add a new
line before or after this with the content
"\includegraphics{$projectlogo}\\"
- Run Doxygen (no source files are needed for this question)
- Doxygen creates two output folders: "html" and "latex"
- Run "make.bat" in the "latex" directory

Re: [Doxygen-users] Doxygen: PROJECT_LOGO and LaTeX

[Stefan P. <ste...@gm...>]

Am 15.03.2018 um 15:53 schrieb Joe Bloggs:
> Hi,
> 
> Should Doxygen's "PROJECT_LOGO" work with LaTeX output?
> 
> I have Win10 with Doxygen v1.8.14 and MiKTeX v2.9 (for pdflatex).
> Here are the minimum steps to demonstrate the question:
> 
> - Create an empty folder
> - In the empty folder create a new Doxyfile with "doxygen -g"
> - Create a new image in the same folder, 150x50 pixels, called "mylogo.jpg"
> - Edit Doxyfile
> - Change PROJECT_LOGO to "PROJECT_LOGO = mylogo.jpg"
> - Run Doxygen (no source files are needed for this question)
> - Doxygen creates two output folders: "html" and "latex"
> - Run "make.bat" in the "latex" directory
> 

Is there any reference to the logo in the TEX files created by doxygen?
You may need to use a custom header to include it.


-- 
*Stefan P.*

Top-posting:
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
A: Top-posting.
Q: What is the most annoying thing in e-mail?

[Doxygen-users] Doxygen: PROJECT_LOGO and LaTeX

[Joe B. <pub...@gm...>]

Hi,

Should Doxygen's "PROJECT_LOGO" work with LaTeX output?

I have Win10 with Doxygen v1.8.14 and MiKTeX v2.9 (for pdflatex).
Here are the minimum steps to demonstrate the question:

- Create an empty folder
- In the empty folder create a new Doxyfile with "doxygen -g"
- Create a new image in the same folder, 150x50 pixels, called "mylogo.jpg"
- Edit Doxyfile
- Change PROJECT_LOGO to "PROJECT_LOGO = mylogo.jpg"
- Run Doxygen (no source files are needed for this question)
- Doxygen creates two output folders: "html" and "latex"
- Run "make.bat" in the "latex" directory

I can see in a web browser that "html/index.html" has the logo image
next to the "My Project" title.  I can also see that Doxygen copied
"mylogo.jpg" to the "html" folder.

However... "latex/refman.pdf" doesn't show the logo even though
Doxygen has copied mylogo.jpg to the "latex" folder.

Any help greatly appreciated thank you.

Re: [Doxygen-users] doxygen best practices?

[Travis E. <tra...@gm...>]

Zach,

As far as I understand, the primary use of tags like these is to be able to
document elements from outside of the code flow (usually in a separate
file), in case you need or prefer to separate them. I think secondary use
is if Doxygen can't identify some element in your language. Personally, I
wouldn't duplicate those values if you're putting the comments directly
before the documented element and Doxygen is correctly identifying it.

Regarding best practices, the best luck I've had is with style guides for
individual projects/companies. It's good to keep your scale, time,
resources, and specific documentation needs in mind. An exhaustive
best-practice that gets ignored because everyone is overworked won't help
much. A good start for sampling some of these style guides is just a google
search: https://www.google.com/search?q=doxygen+style+guide

Cheers,
Travis

On Wed, Feb 21, 2018 at 2:52 AM, Zack Snyder <za...@gm...> wrote:

> Hi there,
>
> when I document my classes always in front of the declaration,
> like this:
>
> /*!
>  * \class MyClass
>  *
>  * \brief Some description
>  *
>  */
> struct MyClass
> {
> };
>
> Is it still usefull to use the \class tag?
> Or is it redundant and should be avoided,
> because it violates the DRY rule?
>
> Regards,
> zack
>
> PS: Are there andy best practices for doxygen? What makes sense to use,
> what not?
>
> ------------------------------------------------------------
> ------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] doxygen best practices?

[Zack S. <za...@gm...>]

<html><head></head><body><div style="font-family: Verdana;font-size: 12.0px;"><div>Hi there,<br/>
&nbsp;<br/>
when I document my classes always in front of the declaration,<br/>
like this:<br/>
&nbsp;<br/>
/*!<br/>
&nbsp;* &#92;class MyClass<br/>
&nbsp;*<br/>
&nbsp;* &#92;brief Some description<br/>
&nbsp;*<br/>
&nbsp;*/<br/>
struct MyClass<br/>
{<br/>
};<br/>
&nbsp;<br/>
Is it still usefull to use the &#92;class tag?<br/>
Or is it redundant and should be avoided,<br/>
because it violates the DRY rule?<br/>
&nbsp;<br/>
Regards,<br/>
zack<br/>
&nbsp;<br/>
PS: Are there andy best practices for doxygen? What makes sense to use, what not?</div></div></body></html>

[Doxygen-users] Doxygen support for Pro*C

[Meghana S. <meg...@in...>]

Hello,

I wanted some help regarding languages supported by doxygen. Particularly  on how to use doxywizard so as to support pro*c . Is there any demo or video or manual available for the same.

Thanks and Regards
Meghana

[Doxygen-users] Alias newline bug in 1.8.14

[Linux M. <lin...@gm...>]

Hello,

I have some aliases in my Doxyfile that look like so:

ALIASES                = "laws=\par Laws\n\parblock"
ALIASES               += "law=\n\par\n"
ALIASES               += "endlaws=\endparblock"

An example of how these are used:

   * \laws
   * \law `p + q == q + p`
   * \law `p + (q + r) == (p + q) + r`
   * \law `p + 0 == p`
   * \endlaws

In Doxygen 1.8.13, this definition worked fine; however, in 1.8.14, I
get the following errors:

warning: Illegal command parblock as part of a title section
warning: Illegal command n as part of a title section
warning: Illegal command n as part of a title section
warning: Illegal command n as part of a title section

Furthermore, the rendering is different -- in 1.8.14, all the text is
bold, as if the paragraph title never ends.

Is there a different way that I should be doing this?

Thanks!
--Nathan

[Doxygen-users] @copybrief with global variables in c

[phaiax <pha...@in...>]

Hello.

I have a C source file with a global variable.

    /** \file myfile.c 
          \brief short deacr
          Long description. */
    UINT16 myvar; /*< blaaa*/

I can see my descriptions in the generated documentation.

And I have a markdown file which I put into the page list with \page.
There I try to use \copybrief myvar but it says it can not find the
identifier. Same with \copybrief myfile.c. Autolinking to the file and the
#myvar works. What is this <link_object> the docs speak of and how does
concating a filename and a global variable work?

I'm using the most recent stable version of doxygen. 

Sincerely, 
Daniel



--
Sent from: http://doxygen.10944.n7.nabble.com/Doxygen-Users-f3.html

[Doxygen-users] Including a .tag file for a library which itself includes a .tag file can provoke duplicate anchor warnings

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

I have three libraries - libA, libB and libC.

libA has a .dox file, which contains the following anchors:

\section First_Section First Section

\subsection First_Subsection First Subsection

libB includes the tag file for libA as follows:
@TAGFILES              =  $(DOXY_OUTPUT)/../libA/libA.tag=../libA

libC includes the tag files for libA and libB, as follows:

@TAGFILES              =  $(DOXY_OUTPUT)/../libA/libA.tag=../libA \
                                   $(DOXY_OUTPUT)/../libB/libB.tag=../libB

However, when I run doxygen on libC in order to generate the documentation
for libC, I see the following warning messages:

libB.tag: warning: Duplicate anchor First_Section found
libB.tag: warning: Duplicate anchor First_Subsection found

It seems that, because libB uses the tagfile for libA, that when libC tries
to use the tagfile for libB, it has in fact already obtained the anchors
from libA and so it considers those it finds in libB relating to libA to be
duplicates.

I am using Doxygen 1.8.10.





--
Sent from: http://doxygen.10944.n7.nabble.com/Doxygen-Users-f3.html

[Doxygen-users] Custom language support in Doxygen

[kildare s. <ksi...@mu...>]

Hello all,

I work with development using a custom version of WML and WMLScript. Its
syntax is similar to Javascript, but it also supports the C/C++
preprocessor commands, such as #include or "ifdef", an example code would
be something like this:

*#include "scriptFile.wmls"*

*function myFunction() : boolean*
*{*
* var b : boolean;*
* b = true; *
* return b;*
*}*

I have been reading the doxygen documentation, but I didn't see a way to
make it recognize the language syntax. Do you believe it is possible
somehow to use any release version to create  documentation for this
language?

Thank you all and Best Regards,

-- 

*KILDARE SILVEIRA*
DEVELOPMENT

+55 (21) 3974-5678 <+55%2021%203974-5678>
www.muxi.com.br

-- 


Esta mensagem (incluindo qualquer anexo) é confidencial e legalmente 
protegida, somente podendo ser usada pelo individuo ou entidade a quem foi 
endereçada. 

Caso você a tenha recebido por engano, deverá devolver ao remetente e, 
posteriormente apagar, pois a disseminação, encaminhamento, uso, impressão 
ou cópia do conteúdo desta mensagem são expressamente proibidos.

This message (including any attachments) contains confidential information 
intended for a specific individual and purpose, and is protected by law. 

If you are not the intended recipient, you should return and then delete 
this message. Any disclosure, copying, printing, use or distribution of 
this message, or the taking of any part is illegal.

[Doxygen-users] Listing C functions

[Aaron G. <aar...@gm...>]

Hi,

How do I list all C functions with menu option to that page ?

also how do I list C Functions under filenames ?

Many thanks in advance,

Aaron

-- 
Aaron Gray

Independent Open Source Software Engineer, Computer Language Researcher,
Information Theorist, and amateur computer scientist.

[Doxygen-users] Nested groups not always nested on the modules page

[Yannick D. <yan...@ya...>]

Hi all, 

Say I have a top‑level group named “foo” and a sub‑group named “bar” in “foo”. If elsewhere I also a group also named “bar”, however as a top‑level group, then in the modules pages, Doxygen display the top‑level “bar” with the “bar” which is a sub‑group of “foo”. 

I mean if I have something like this: 

    Group Foo 
      Content-of-foo 
      Sub group Bar 
        Content-of-bar-1 

    Group bar 
      Content-of-bar-2 

Then Doxygen understands it like this: 

    Group Foo 
      Content-of-foo 
      Sub group Bar 
        Content-of-bar-1 
        Content-of-bar-2 

Is this expected or is this a bug? 

-- 
Yannick Duchêne

[Doxygen-users] Nested groups not always nested on the modules page

[Yannick D. <yan...@ya...>]

Hi all,

Say I have a top‑level group named foo and a sub‑group named bar in foo. If
elsewhere I also a group also named bar, however as a top‑level group, the
in the modules, Doxygen display the top‑level bar in the bar which is a
sub‑group of foo.

I mean if I have something like this:

    Group Foo
      Content-of-foo
      Sub group Bar
        Content-of-bar-1

    Group bar
      Content-of-bar-2

Then Doxygen understands it like this:

    Group Foo
      Content-of-foo
      Sub group Bar
        Content-of-bar-1
        Content-of-bar-2

Is this expected or is this a bug?




--
Sent from: http://doxygen.10944.n7.nabble.com/Doxygen-Users-f3.html

Re: [Doxygen-users] How to link to entities in the current file, only?

[Yannick D. <yan...@ya...>]

That’s OK, I will just use a filter like this:

    #!/bin/sh

    NS=$(basename "$1")
    NS=${NS%.*}

    echo "namespace $NS {"
    cat "$1"
    echo "}"



On Mon, 25 Dec 2017 17:25:49 -0700 (MST)
Yannick Duchêne via Doxygen-users <dox...@li...> wrote:

> Hi there,
> 
> As I understand Doxygen, it favours namespaces. I’m documenting an
> application whose UI use JavaScript. I have a main file for each page. Each
> of these main files have homonyms function names. On of these functions is
> simply called `main`.
> 
> Say I have `page1.js` to `page9.js `. From say `page1.js`, if I write `@ref
> #main`, it will link to that of `page9.js`, the same from `page2.js` and so
> on.
> 
> Since I refers a lot to function/constant names from comments, that’s a
> important deal (function and constant names takes parts in sentences as
> verbs and words).
> 
> My guess is that the file should be a namespace, but there is no proper
> namespace construct with JavaScript (I naively tried to add `@namespace` at
> the top of tiles, but does not change anything). The only way a kind of
> namespace may appears, is when a module is imported (new in ES6). Even so,
> the imported module does not belong to a namespace, it’s a simple JavaScript
> file with just optional `export` keywords and `import`. So I have to do
> without namespaces. And anymway, these main files are not to be imported.
> 
> The C world is used to circumvent the lack of modularity, giving unique
> names to each things. But there are statics in C and a C application may be
> complied using different file providing similar functions with equal names.
> So that’s not really a JavaScript specific issue.
> 
> May be I could wrap everything in classes, but I don’t enjoy the idea of
> this kind of modifications just to circumvent this (I don’t mind tweaking
> the source to please Doxygen, but not this level of modifications). And a
> class has a meaning, an intent (ex. it has a constructor, to return multiple
> instances), it’s not to be used everywhere or for no good technical reasons.
> 
> I wonder if and how some people found their way with this, either with
> JavaScript or C, since I feel to guess a solution for C could be applicable
> to JavaScript.
> 
> if that matters, the application also uses Python, even more than
> JavaScript, so the Doxyfile is configured to optimize for Java, which is
> what’s recommended for Python. Is there a risk optimizing for Java prevents
> me from finding a proper solution?
> 
> Have a merry Christmas as much as you can …
> 
> 
> 
> --
> Sent from: http://doxygen.10944.n7.nabble.com/Doxygen-Users-f3.html
> 
> ------------------------------------------------------------------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users


-- 
Yannick Duchêne

[Doxygen-users] How to link to entities in the current file, only?

[Yannick D. <yan...@ya...>]

Hi there,

As I understand Doxygen, it favours namespaces. I’m documenting an
application whose UI use JavaScript. I have a main file for each page. Each
of these main files have homonyms function names. On of these functions is
simply called `main`.

Say I have `page1.js` to `page9.js `. From say `page1.js`, if I write `@ref
#main`, it will link to that of `page9.js`, the same from `page2.js` and so
on.

Since I refers a lot to function/constant names from comments, that’s a
important deal (function and constant names takes parts in sentences as
verbs and words).

My guess is that the file should be a namespace, but there is no proper
namespace construct with JavaScript (I naively tried to add `@namespace` at
the top of tiles, but does not change anything). The only way a kind of
namespace may appears, is when a module is imported (new in ES6). Even so,
the imported module does not belong to a namespace, it’s a simple JavaScript
file with just optional `export` keywords and `import`. So I have to do
without namespaces. And anymway, these main files are not to be imported.

The C world is used to circumvent the lack of modularity, giving unique
names to each things. But there are statics in C and a C application may be
complied using different file providing similar functions with equal names.
So that’s not really a JavaScript specific issue.

May be I could wrap everything in classes, but I don’t enjoy the idea of
this kind of modifications just to circumvent this (I don’t mind tweaking
the source to please Doxygen, but not this level of modifications). And a
class has a meaning, an intent (ex. it has a constructor, to return multiple
instances), it’s not to be used everywhere or for no good technical reasons.

I wonder if and how some people found their way with this, either with
JavaScript or C, since I feel to guess a solution for C could be applicable
to JavaScript.

if that matters, the application also uses Python, even more than
JavaScript, so the Doxyfile is configured to optimize for Java, which is
what’s recommended for Python. Is there a risk optimizing for Java prevents
me from finding a proper solution?

Have a merry Christmas as much as you can …



--
Sent from: http://doxygen.10944.n7.nabble.com/Doxygen-Users-f3.html

Re: [Doxygen-users] The Python documentation example page is empty

[Greg A. <Gre...@do...>]

There is no mainpage description provided by the example but look under “Packages”, “Classes” or “Files” and you’ll find everything.

From: Ashton, Tristan Nicholas [mailto:tri...@in...]
Sent: 07 December 2017 17:19
To: dox...@li...
Subject: [Doxygen-users] The Python documentation example page is empty

I'm trying to use Doxygen to document a python file and the example page (http://www.stack.nl/~dimitri/doxygen/manual/examples/pyexample/html/index.html) is completely empty and gives no information about how the output is supposed to look
This Email and any files transmitted with it are intended only for the person or entity to which it is addressed and may contain confidential and/or privileged material. Any reading, redistribution, disclosure or other use of, or taking of any action in reliance upon, this information by persons or entities other than the intended recipient is prohibited. If you are not the intended recipient please contact the sender immediately and delete the material from your computer. E-mail may be susceptible to data corruption, interception, viruses and unauthorised amendment and Domino UK Limited<http://www.domino-printing.com/Channels/UK/eng/Home.aspx> does not accept liability for any such corruption, interception, viruses or amendment or their consequences.


Domino UK Limited<http://www.domino-printing.com/Channels/UK/eng/Home.aspx> Registered in England. Registered Number:1750201. Registered Office Address: Trafalgar Way, Bar Hill, Cambridge, CB23 8TU.