Adabrowse: What config setup do people use?

Adabrowse: What config setup do people use?

[chris]

Hi,

I'm toying with Adabrowse just now and am trying to make a cfg file for 
project documentation.  Does anyone have samples of the markup they use 
and the cfg they use with it?  It'd be helpful to help understand how it 
works.

I'm looking to document exceptions thrown by subprograms and output 
something a bit closer to javadoc (with summaries and more detailed 
sections)... but am not sure where to start.  (I'm not asking for help 
specifically to generate this sort of thing, just a prod to get started).


Cheers,
Chris

Re: Adabrowse: What config setup do people use?

[Martin Dowie]

"chris" <spamoff.danx@ntlworld.com> wrote in message
news:bC75b.4578$bC1.3733@newsfep4-winn.server.ntli.net...
> Hi,
>
> I'm toying with Adabrowse just now and am trying to make a cfg file for
> project documentation.  Does anyone have samples of the markup they use
> and the cfg they use with it?  It'd be helpful to help understand how it
> works.
>
> I'm looking to document exceptions thrown by subprograms and output
> something a bit closer to javadoc (with summaries and more detailed
> sections)... but am not sure where to start.  (I'm not asking for help
> specifically to generate this sort of thing, just a prod to get started).

I use a config file containing:

Format."--!" = pre
Index.Constants.Title = Constant Index
Index.Constants.Rule = constant
Index.Exceptions.Title = Exception Index
Index.Exceptions.Rule = exception

but there is nothing in AdaBrowse that will let you list where each
exception is
raised.

Re: Adabrowse: What config setup do people use?

[chris]

Martin Dowie wrote:

> I use a config file containing:
> 
> Format."--!" = pre
> Index.Constants.Title = Constant Index
> Index.Constants.Rule = constant
> Index.Exceptions.Title = Exception Index
> Index.Exceptions.Rule = exception

Cheers.  I think I'm getting the hang of it now...

> but there is nothing in AdaBrowse that will let you list where each
> exception is raised.

Not actually detect each one but I was going to document them with in 
the comments (only the immediate ones though)...

<exceptions>goes_nuts</exceptions>



Chris

Re: Adabrowse: What config setup do people use?

[chris]

chris wrote:
> Martin Dowie wrote:
> 
>> I use a config file containing:
>>
>> Format."--!" = pre
>> Index.Constants.Title = Constant Index
>> Index.Constants.Rule = constant
>> Index.Exceptions.Title = Exception Index
>> Index.Exceptions.Rule = exception
> 
> 
> Cheers.  I think I'm getting the hang of it now...

to a degree. :)

Does anyone know how to turn off the "other items section" and configure 
it not to output into a tabular style?  Maybe it can't do the formatting 
I want?

Here's a sample of the kindof thing I'd like...

name of package
description
list of types + declaration
list of operations linked to detailed descriptions + declaration
details of operations (i.e. the comments)

with no tables!

What tool does gtkada use?

Re: Adabrowse: What config setup do people use?

[Marc A. Criley]

chris <spamoff.danx@ntlworld.com> wrote in message news:<7Bj5b.167$1%2.2016@newsfep4-glfd.server.ntli.net>...

<snip>

Just a general comment about the author's support for AdaBrowse: 
Thomas Wolf has been _very_ receptive to ideas on how to improve
AdaBrowse, I've made two suggestions for improvement and both were
incorporated as new features.

So I think if you can clearly and concisely identify some feature or
capability you would like, Thomas would be glad to hear you out.

Marc