Giter Site home page Giter Site logo

doxygen-struct-anchor-issue's Introduction

This is a pair of fake C projects, low and high, with high depending on low. They each have a header file, which has a typedef to a struct and a typedef to a pointer to that (all of this documented).

/** ... */
typedef struct {...} OBJECT_s;
/** ... */
typedef OBJECT_s * OBJECT_p;

That is not necessarily a practice I particularly condone, but valid C nontheless.

Doxyfiles and Makefiles have been provided to generate the documentation and tagfile for low, and the documentation for high using low's tagfile.

A simple call to make in this repo's root will make both docs, and should hopefully reproduce the warning I am trying to understand / avoid / fix when building the high doc.

low/doxygen.tag:26: warning: Unexpected tag `anchor' found

The mentioned line is the following:

23  <compound kind="struct">
24    <name>object</name>
25    <filename>low_8h.html</filename>
26    <anchor>structobject</anchor>    <!-- CULPRIT LINE -->
27    <member kind="variable">
28      <type>int</type>
29      <name>val</name>
30      <anchorfile>low_8h.html</anchorfile>

To see how the Doxyfiles were made, I included references (made with doxygen -g) and the differences can be displayed with a simple call to make Doxyfile-diff which will call diff in both projects.

For info, these are the relevant changes at the time of writing this :

make -C low  Doxyfile-diff

> INLINE_SIMPLE_STRUCTS  = YES
> INPUT                  = .
> GENERATE_LATEX         = NO
> GENERATE_TAGFILE       = doxygen.tag

make -C high Doxyfile-diff

> INPUT                  = .
> GENERATE_LATEX         = NO
> TAGFILES               = ../low/doxygen.tag=../../low/html

doxygen-struct-anchor-issue's People

Contributors

trosh avatar

Watchers

 avatar  avatar

doxygen-struct-anchor-issue's Issues

Solved problem

In my mailbox I found the message you posted to the doxygen user group in 2017.

I ran your problem with doxygen 1.8.13 (looks like the version you used / the current version at that moment) and could reproduce the problem.

I ran the problem with the current version (1.8.15) of doxygen and the message does not appear anymore.

I think the problem has been solved in the mean time, in case this is not the case please file an issue in the doxygen issue tracker (https://github.com/doxygen/doxygen/issues/new)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.