Re: Customizing Synopsis output

Stefan Seefeld <[email protected]> Thu, 09 Feb 2012 11:04:53 -0500
Newsgroups gmane.comp.documentation.synopsis
Message-ID <[email protected]>
On 01/30/2012 06:46 PM, Tim Cas wrote:
> Hey there, I'm working on getting the output of Synopsis customized for
> my game engine: http://libsiege.org <http://libsiege.org/>
> 
> I've managed to get the pages and index to ignore anything with a '`'
> (anonymous unions/structs) or '_' (private members) prefixes, but I
> still have some problems:
> 
> - constants (for which I use #define's) are shown as macros - I'd like
> to show them as constants

Can you elaborate a little on what you mean by 'as constants' ? Macros
and constants have quite different semantics, so I document them
differently. Are you merely asking to change the heading in HTML output
to not have the word 'Macro' in it ? Or something more involved ?

> - the file tree doesn't work (I cannot open any subdirectories)

OK, I have to look into that. Can you provide a specific test case
that's not working ?

> - I can't find a way to rename "Global Namespace" to something else
> (this is C, not C++, so that name doesn't make much sense)

Right. Have you tried using a different view ? Perhaps the 'ModuleView'
(which is used by default) makes indeed no sense for C projects (which
don't have any nested scopes).

> - name index is missing functions (I can only see structs and defines there)

Can you please provide a minimal test case showing the behavior ?


> - everything is in globals.html (instead of per-file stuff, say
> foo/bar.h.html for items located in in foo/bar.h)

There are different views that display information in different ways.
The "ModuleView" shows information per scope, and thus groups all
"global" symbols in a single view. There are also "FileListing" and
similar views that present per-file symbols (with docs).

> - Texlive output is broken on my end...?

What format are you using ? There is no direct TeX format in Synopsis.

> I'll also have to find out how to get manpage output up and running,
> plus (I suppose) LaTeX/PDF.

You may be interested in the DocBook formatter, from which man pages and
pdf docs can be generated.

Thanks,
		Stefan

-- 

      ...ich hab' noch einen Koffer in Berlin...