This is the mail archive of the gcc@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: Doxygen for GCC


On Thu, 2017-06-08 at 21:35 -0400, Eric Gallager wrote:
> On 6/8/17, Martin Liška <mliska@suse.cz> wrote:
> > On 04/28/2017 02:32 PM, Martin Liška wrote:
> > > I'm planning to periodically build it and rsync to a public
> > > website.
> > > I guess, sometimes it can be handy.
> > 
> > Done that (it's weekly updated):
> > 
> > http://gcc.opensuse.org/gcc-doxygen/
> > 
> > Martin
> > 
> 
> Clicking on the first link on the sidebar, it looks like doxygen
> needs
> to be taught how to handle gcc's kind of md files:
> http://gcc.opensuse.org/gcc-doxygen/md_gcc_common.html

Gah.

> Has there been a bug raised with doxygen for this?

Not AFAIK.

Presumably Doxygen is treating our .md files as one of the family of
Markdown formats:
  https://www.stack.nl/~dimitri/doxygen/manual/markdown.html
rather than as a machine description file.

Not sure how to fix this.  Looking at contrib/gcc.doxy, maybe we could
set:
   FILTER_PATTERNS        = *.md=my_md_filter
   FILTER_SOURCE_FILES    = yes
or somesuch, and implement a my_md_filter script to turn the .md file
into something (maybe a markdown version of the machine description?)


Dave


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]