doxygen-users — List for users of doxygen

[Doxygen-users] Include source path from another doxyfile

[Franz F. <f.f...@gm...>]

Hi,

I'm often using git submodules in my projects. Each submodule has it's
own doxyfile. If i include the submodule in my parent project, there's
a seperate doxyfile, but i don't want to specify the sources again for
each submodule. Is there a way, to include the sources of a doxyfile
into another doxyfile?

Yours
Franz

Re: [Doxygen-users] HTML error

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

Am 15.08.2018 um 19:28 schrieb Mar...@mi...:
> Thanks for the info.
> 
> Would that be a problem with the doxygen markup in my code or a problem with doxygen itself?
> 

Since we don't know your code nor your settings, this will just be guessing.
If you create a small and simple example to duplicate the problem, it 
will be much easier to get hold of the root cause.


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

Re: [Doxygen-users] HTML error

[<Mar...@mi...>]

Thanks for the info. 

Would that be a problem with the doxygen markup in my code or a problem with doxygen itself?

-----Original Message-----
From: Stefan Pendl <ste...@gm...> 
Sent: Wednesday, August 15, 2018 5:19 AM
To: dox...@li...
Subject: Re: [Doxygen-users] HTML error

Am 14.08.2018 um 23:03 schrieb Mar...@mi...:
> I generate html and a chm with Doxygen 1.8.14 and whenever I open the 
> chm I get the following error on every single page:
> 
>      Script Error
> 
>      Error: The value of the property '$' is null or undefined, not a 
> Function object
> 
> If I look at the html I see the following in each file:
> 
>      <script type="text/javascript">
> 
>      /* @license
> magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gp
> l-2.0.txt
> GPL-v2 */
> 
>      $(function() {
> 
>        initMenu('',false,false,'search.php','Search');
> 
>      });
> 
>      /* @license-end */</script>
> 

It seems that a placeholder was not replaced correctly.

The code should more look like the following:

<script type="text/javascript">
/* @license
magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt
GPL-v2 */

function() {
     initMenu('',false,false,'search.php','Search');
};

/* @license-end */
</script>

 From my point of view, the definition of function() is overkill.


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

------------------------------------------------------------------------------
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] HTML error

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

Am 14.08.2018 um 23:03 schrieb Mar...@mi...:
> I generate html and a chm with Doxygen 1.8.14 and whenever I open the 
> chm I get the following error on every single page:
> 
>      Script Error
> 
>      Error: The value of the property ‘$’ is null or undefined, not a 
> Function object
> 
> If I look at the html I see the following in each file:
> 
>      <script type="text/javascript">
> 
>      /* @license 
> magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt 
> GPL-v2 */
> 
>      $(function() {
> 
>        initMenu('',false,false,'search.php','Search');
> 
>      });
> 
>      /* @license-end */</script>
> 

It seems that a placeholder was not replaced correctly.

The code should more look like the following:

<script type="text/javascript">
/* @license 
magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt 
GPL-v2 */

function() {
     initMenu('',false,false,'search.php','Search');
};

/* @license-end */
</script>

 From my point of view, the definition of function() is overkill.


-- 
*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] HTML error

[<Mar...@mi...>]

Howdy,

I've googled around and can't find anything so far:

I generate html and a chm with Doxygen 1.8.14 and whenever I open the chm I get the following error on every single page:

    Script Error
    Error: The value of the property '$' is null or undefined, not a Function object

If I look at the html I see the following in each file:

    <script type="text/javascript">
    /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
    $(function() {
      initMenu('',false,false,'search.php','Search');
    });
    /* @license-end */</script>

I can open these files in a browser and get no errors. Any ideas what's going on here?

I downloaded the latest 1.3 MS Help Workshop installer and it runs but gives a weird "Updating to 1.31" dialog saying that I already have a newer version.


Thanks!

Re: [Doxygen-users] want to create huge call graph

[Patrick <pa...@sp...>]

Just in case this helps some one, I changed this from 50 to 500 and
ended up with a massive graph:

DOT_GRAPH_MAX_NODES    = 500

It's very slow to produce but it doesn't bother me....

Freedom is about choice.

Re: [Doxygen-users] want to create huge call graph

[Patrick <pa...@sp...>]

Hi Everyone

Please don't pre-judge me. I am in a very unusual and very difficult
situation. My workflow looks nothing like yours-Patrick

Re: [Doxygen-users] want to create huge call graph

[Patrick <pa...@sp...>]

forget it, I will figure this out myself.

Just for the record, I hardly have any time to look at multiple files(I
can late at night but I am too exhausted). I am caring for sick loved
ones and the best I can do is look at a graph on the wall in the
fleeting moments I have between different tasks I need to do for them.

Re: [Doxygen-users] want to create huge call graph

[Shawn H C. <sha...@gm...>]

On Fri, 20 Jul 2018 17:45:04 -0400
Patrick <pa...@sp...> wrote:

> Hi Everyone
> 
> Please don't pre-judge me. I am in a very unusual and very difficult
> situation. My workflow looks nothing like yours-Patrick
> 
> 

Since you can't possibly know my workflow, I think we can agree that we
both don't know the size of each other's shoes. 😉

Humongous graphs are just as hard to understand as multiple files. The
key to both is to understand the parts and build up from there.


-- 
Don't stop where the ink does.

	Shawn H Corey

Re: [Doxygen-users] want to create huge call graph

[Shawn H C. <sha...@gm...>]

On Fri, 20 Jul 2018 13:44:27 -0400
Patrick <pa...@sp...> wrote:

> I want to create an enormous call graph to mount on a wall.

In my experience, people who want to create enormous graphs think they
will make it easier to understand something that is very complex. It
won't.

To understand something complex requires isolation of its parts. In
computese, it's called encapsulation. Each part has an interface and
understanding the whole thing requires building up knowledge by
understand the interface to each part.


-- 
Don't stop where the ink does.

	Shawn H Corey

[Doxygen-users] want to create huge call graph

[Patrick <pa...@sp...>]

Hi Everyone

This is my first post here.

I want to create an enormous call graph to mount on a wall. I tried
changing this:

HTML_INDEX_NUM_ENTRIES = 1000

but it didn't seem to help. Is there a way to create a super huge PNG ?

Thanks for reading-Patrick

[Doxygen-users] Configuration problems

[Rene 'R. B. B.S. I. <ml...@ba...>]

Hi,

I'm new to the list, so a "Hello" to all! :-)

I created a Doxyfile for the Sonoff-Tasmota project (C/C++, 
https://github.com/arendst/Sonoff-Tasmota/raw/development/Doxyfile). 
Most of the code is not documented, yet. So I enabled EXTRACT_ALL. 
Doxygen documents only a small fraction of the code. The C-Code in my 
MPR121 driver isn't documented, too 
(https://github.com/arendst/Sonoff-Tasmota/pull/3142/commits/a01edf6fd2152f12f541cf47f4ab4afc70272a4a).

Because of the lack of documentation in Sonoff-Tasmota it is important 
to document all of the (undocumented) code with Doxygen, especially 
call- and caller graphs to understand the code flow.

Does anybody have an idea what's wrong in the Doxyfile?

Thanx for any hint,

Renne

[Doxygen-users] Need help working around some doxygen/C# issues

[Daniel T. <ma...@da...>]

Dear List,

i have encountered some issues trying to generate documentation for an
existing codebase, and would appreciate any help - fixing them or
working around them. Maybe i just need some configuration options?

In short, they are:

- If i have both Klass and Klass<T>, only one of them gets proper documentation.

- If i have MyImplementation<T> implementing the interface
MyClass<T>.MyNestedInterface, doxygen gets the inheritance wrong
(obviously its not really inheritance, but i suspect this is a known
thing :)

- docs for attributes, properties and functions documented in an
interface should turn up at the implementation - or am i mistaken?

I have created a small github repo to show the problems:
https://github.com/dturing/doxygen-csharp-issues

Does anyone have any idea how to work around these things (apart from
changing code)? Or maybe i'm missing some config options?

Any help appreciated!

-daniel

[Doxygen-users] Section id only alphanumerical from 1.8.14

[Tom D. <tom...@in...>]

Hello,

I am working on this project : https://sbl.inria.fr/doc, where the 
documentation is done with Doxygen.

We were used to define the id of our sections with the symbol "-" to 
separate the words in the id, but it looks like the convention has 
changed since 1.8.14 and only alpha-numerical characters are accepted.

Unfortunately, we have a large number of pages, and before reviewing the 
whole documention, I wanted to know if there is anything that I am 
missing, like a Doxygen option to turn ON / OFF

Thanks for your awesome work !

Tom.

[Doxygen-users] Doxygen bugtracker moved

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

Hi All,

Doxygen has used the GNOME bugzilla database for issue tracking for many years.
Now that service will be discontinued, I have moved all existing issues to GitHub.
From now on, bug reports and enhancement requests can be found and reported there.

Kind regards,
  Dimitri

[Doxygen-users] C# reference to property

[Guilherme <gui...@gm...>]

Hallo,

It seems I'm unable to create a reference to a class property.

Example

namespace  foo.bar {

class X {

public Prop {get; set;}

}
}

Now in a markdown file I'd write:

Look at [class X.Prop](@ref foo.bar.X.Prop).

But it won't resolve. foo.bar.X works fine though.

What am I doing wrong?

Best regards,
Gui

[Doxygen-users] Disabling all items except properties still shows members

[Guilherme <gui...@gm...>]

Hi,

Using DoxygenLayout.xml one can enable and disable which items to show in
the class overview.

When i try to turn everything off except for properties it will still
display public member methods and events.

Is this a bug?

This is c# source with Doxygen 1.8.13.

Best regards

[Doxygen-users] In markdown, list continuation renders as code

[DonM <dm4...@in...>]

I am trying to use multi-level lists in a markdown file, with "list continuation" -- by that I mean a list item that has multiple paragraphs. For example, consider this markdown input:

1.  List item 1

     List item 1 continuation

     a.  List item 1a

         List item 1a continuation

     b. List item 1b

2.  List item 2

Doxygen renders most of this correctly. In particular "List item 1 continuation" is a separate paragraph below list item 1, and indented to match the text in item1.

However, "List item 1a continuation" is rendered as a code block -- inside a box (border) with a fixed width font. And it is only indented to match the text in item 1 (not item 1a).

I'm using the current version (1.8.14). Is there any way around this? Thanks,

DonM

Re: [Doxygen-users] Q: use doxygen to document SQL schema files?

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

Hi Bob:

Am 08.06.18 22:01 schrieb(en) Robert Hairgrove:
> There have been one or two noteworthy efforts ... check out the Doxygen website, maybe there is something new out there.

Nothing, unfortunately…

> In the meantime, you might want to look into SchemaSpy and its GUI:
> 
> http://schemaspy.sourceforge.net/
> http://www.joachim-uhl.de/projekte/schemaspygui/
> http://schemaspygui.sourceforge.net/

Thanks a lot for that hint, it actually looks much better than  PostgreSQL Autodoc (<https://github.com/cbbrowne/autodoc>)!

> Sadly, none of these tools seems capable of documenting stored procedures or views.

This is exactly what I miss from PSQL-Autodoc, in particular the documentation of the DB functions!

In my project, they provide a simple “middleware” between the db and the user apps, so it would be cool to let doxygen (or some other tool) extract the description from PostgreSQL's “COMMENT ON” (non-standard, unfortunately) statements, and create the usual cross-references (call/caller graphs, DB function/table relationships, …).

Cheers,
Albrecht.

[Doxygen-users] Q: use doxygen to document SQL schema files?

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

Hi all,

the subject says it all – would it be possible to use Doxygen to document SQL schema files, specifically PostgreSQL 10.4 schema dumps?

Cheers,
Albrecht.

[Doxygen-users] Global definition of folders

[Gaurav M. <gm...@gm...>]

<html><head></head><body><div style="font-family: Verdana;font-size: 12.0px;"><div>Hello,</div>

<div>&nbsp;</div>

<div>My project has a directory structure with several unique directories. But each directory inturn has 4 common directories like</div>

<div>&#124;&#92;dir1</div>

<div>&#124;&nbsp;&nbsp; &#124;&#92;test</div>

<div>&#124;&nbsp;&nbsp; &#124;&#92;ui</div>

<div>&#124;&#92;dir2</div>

<div>&#124;&nbsp;&nbsp; &#124;&#92;test</div>

<div>&#124;&nbsp;&nbsp; &#124;&#92;ui<br/>
&nbsp;</div>

<div>I want to set the definition/documentation for test and ui directories which can appear globally. I tried creating definition in a top level file as</div>

<div>/**</div>

<div>&nbsp;* &#92;dir test</div>

<div>&nbsp;* &#92;brief Test directory for the module</div>

<div>&nbsp;* &#92;dir ui</div>

<div>&nbsp;* &#92;biref UI for the module</div>

<div>&nbsp;*/</div>

<div>&nbsp;</div>

<div>The definition is appearing only for one directory. Your help is appreciated.</div>

<div>&nbsp;</div>

<div class="signature">Thanks and regards,<br/>
Gaurav Mishra<br/>
+91 984 070 2660</div></div></body></html>

Re: [Doxygen-users] \todo inside C# XML comment

[Clemens F. <c....@os...>]

Clemens Feige wrote on 07.05.2018 at 18:31:
> Hello
> 
> I have an issue with the \todo command being used inside C# XML comments:
> 
> Warnings are generated inside the log-file:
>    "warning:Unexpected tag dd found"
> 
> The HTML output of the TODO list (at "related pages") is damaged. Note 
> that technically the TODO list is made from a HTML "description list" 
> which may explain the mysterious warning about the <dd> tag.
> 
> I believe my issue is essentially the same as bug #746419
> 
> https://bugzilla.gnome.org/show_bug.cgi?id=746419#c0
> 
> I can confirm that entering a empty comment line after the \todo 
> mysteriously improve the situation.
> 
> I have a minimal working example. Shall I append this to the ticket 
> (which is from 2015) or create a new ticket?
> 
> Has anybody the same observation?
> 
> Thanks
> Clemens


Hello

Just for the records ...

I have attached my minimal working example to the bug #746419

https://bugzilla.gnome.org/show_bug.cgi?id=746419#c0

A diligent doxygen developer has already proposed a patch. My hope is 
that the issue will be fixed with the next doxygen release after the 
current 1.8.14.

Clemens

Re: [Doxygen-users] Make server side search work

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

>To be sure to not have something else interfering I now created a new
>machine with Ubuntu 18.04, Apache2, Php7.2, Doxygen 1.8.13 and
>all needed dependencies. The internal search didn't work, same as
>before. After searching no results are displayed and the layout is
>messed up.
>
>Then I tried the external search with the doxyindexer/doxysearch.cgi.
>I created the database and setup the search as described here:
>https://www.stack.nl/~dimitri/doxygen/manual/extsearch.html
>
>Testing worked with "Test failed: cannot find search index doxysearch.db"
>and also "Test successful". However the searching for a real string
>didn't work either. The layout is conserved but still no results are
>returned.
>
>The direct search call does return a result like
>
>http://127.0.0.1/bin/doxysearch.cgi?q=clj
>
>({
>  "hits":1,
>  "first":0,
>  "count":1,
>  "page":0,
>  "pages":1,
>  "query": "clj",
>  "items":[
>  {"type": "page",
>   "name": "index::mcrobot",
>   "tag": "",
>   "url": "mcrobot.html",
>   "fragments":[
>   ]
>  }
> ]
>})
>
>But searching from the search box is just empty
>
>http://127.0.0.1/search.html?query=clj

I debugged it down to search.js:

function searchFor(query,page,count) {
  $.getJSON(serverUrl+"?cb=?",
  {
    n:count,
    p:page,
    q:query
  },
  function(data) {

It seems like the getJSON call is never successful and the success
function is never called, even tough the same call directly executed
does return a result.

I finally got the external search to work. The problem was the search
URL. Initially I had only the server string without protocol. Seems like
the getJSON function doesn't like this. It only worked after I added
http:// (or https://) to the search URL.

It would be nice if there was some error message stating that the
call itself failed and that the search URL is probably wrong. That
would have saved me some time as I never knew where the problem
was.

And I still don't know what the problem with the internal search is.
But I'm now going with the external search as this is recommended.

Thanks

bye  Fabi

[Doxygen-users] Markdown with ISO-8859-1 rendering

[Carlos D. <car...@gm...>]

Hi,

I was documenting the main page of a C project in a dedicated .c file so to
avoid this file to become huge i'm porting the pages into separated
markdown files.

My problem:
I'm documenting the project in Spanish so i use a lot of accents on the
vowels, to render the accents properly i had to set the INPUT_ENCODING
option to ISO-8859-1, so far so good.

Now when i separate the pages into markdown files the accents are not
encoded properly, is this a known issue? am i missing something to enable
the ISO-8859-1 rendering in the markdown files?

Regards

Doxygen used: 1.8.14

Re: [Doxygen-users] Make server side search work

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

At 10:22 14.05.2018, you wrote:
>At 09:47 09.05.2018, you wrote:
>>Hi
>>
>>We put the doxygen generated documentation on a server and used
>>the client side search previously. However some words could not be
>>found as the client side search is not a full text search. That's why
>>we now wanted to switch to server side search to get better results.
>>
>>The server is a linux with Apache with php, we also have e.g. MantisBT
>>(bugtracker) and DocuWiki running on the same server, so php (7) is
>>running fine. The documentation is generated on a different computer
>>and then the whole html directory (output from doxygen) is copied
>>to the live server.
>>
>>But when I try to search for something no results are returned, just
>>like in this question:
>>
>>https://stackoverflow.com/questions/48440476/doxygen-server-side-searching-does-not-work
>>
>>These are the options from my Doxyfile:
>>
>>SEARCHENGINE           = YES
>>SERVER_BASED_SEARCH    = YES
>>EXTERNAL_SEARCH        = NO
>>SEARCHENGINE_URL       =
>>SEARCHDATA_FILE        = searchdata.xml
>>
>>In the html/search directory is a search.idx file with all the text strings.
>>I don't see errors in the logfiles in /var/log/.
>>
>>Is something else needed? Is there some debugging I can enable?
>
>Still trying to make this work. Has anybody used this?
>Should this work with PHP7?

To be sure to not have something else interfering I now created a new
machine with Ubuntu 18.04, Apache2, Php7.2, Doxygen 1.8.13 and
all needed dependencies. The internal search didn't work, same as
before. After searching no results are displayed and the layout is
messed up.

Then I tried the external search with the doxyindexer/doxysearch.cgi.
I created the database and setup the search as described here:
https://www.stack.nl/~dimitri/doxygen/manual/extsearch.html

Testing worked with "Test failed: cannot find search index doxysearch.db"
and also "Test successful". However the searching for a real string
didn't work either. The layout is conserved but still no results are
returned.

The direct search call does return a result like

http://127.0.0.1/bin/doxysearch.cgi?q=clj

({
  "hits":1,
  "first":0,
  "count":1,
  "page":0,
  "pages":1,
  "query": "clj",
  "items":[
  {"type": "page",
   "name": "index::mcrobot",
   "tag": "",
   "url": "mcrobot.html",
   "fragments":[
   ]
  }
 ]
})

But searching from the search box is just empty

http://127.0.0.1/search.html?query=clj

Is the server based search already usable or work in progress?
So far I think I need to go back to the client based search which
is still better than having no results at all.

Thanks

bye  Fabi