doxygen-develop

[Doxygen-develop] PATCH: Add tags for tabular lists (ala \param, \retval, etc)

[mwoehlke <mwo...@ti...>]

The attached patch adds \li2 and \li3 tags to Doxygen (diff'd against 
1.4.7). \li2 is identical to \param except that it does not cause a 
section to be created, and so can be used with custom sections (\par) or 
in the detailed description. \li3 uses the first (typically unused) 
column to make three-column lists (\li2 does 2-column lists, obviously); 
it treats '-' as an empty cell.

Needed improvements:
- Support the new tags in other output formats (shouldn't be difficult, 
but I don't feel familiar enough with the code - or LaTeX for that 
matter - to want to mess with it).

Suggested improvements:
- Allow mixing \li2 and \li3 in the same table/list (and then remove 
treating '-' as empty).
- Add \li1?

I'm also open to suggestions on how to make the new code less ugly (for 
instance, not needing the second params list would be nice).

-- 
Matthew
Will your shell have salvation? Only if it's Bourne Again.

Re: [Doxygen-develop] PATCH: Add tags for tabular lists (ala \param, \retval, etc)

[mwoehlke <mwo...@ti...>]

mwoehlke wrote:
> The attached patch adds \li2 and \li3 tags to Doxygen (diff'd against 
> 1.4.7). \li2 is identical to \param except that it does not cause a 
> section to be created, and so can be used with custom sections (\par) or 
> in the detailed description. \li3 uses the first (typically unused) 
> column to make three-column lists (\li2 does 2-column lists, obviously); 
> it treats '-' as an empty cell.
> 
> Needed improvements:
> - Support the new tags in other output formats (shouldn't be difficult, 
> but I don't feel familiar enough with the code - or LaTeX for that 
> matter - to want to mess with it).
> 
> Suggested improvements:
> - Allow mixing \li2 and \li3 in the same table/list (and then remove 
> treating '-' as empty).
> - Add \li1?
> 
> I'm also open to suggestions on how to make the new code less ugly (for 
> instance, not needing the second params list would be nice).

Any comments?

-- 
Matthew
Download. Untar. Configure. Make. Install. Lather. Rinse. Repeat.

[Doxygen-develop] Aliases to create tables

[<Eck...@t-...>]

Hello everybody.


I often use the following examples to create tables:

ALIASES     = "TabBegin = <TABLE><TR><TD>" \
                         "TabEnd   = </TD></TR></Table>" \
                         "I        = </TD><TD>" \
                         
"I________________________________________________________________________________ 
= </TD></TR><TR><TD>" \
                         
"I_______________________________________________________________________________ 
= </TD></TR><TR><TD>" \
                         
"I______________________________________________________________________________ 
= </TD></TR><TR><TD>" \
                            .
                            .
                            .
                               the number of "_" changes from 80 to 1
                            .
                            .
                            .
                         "I_ = </TD></TR><TR><TD>"

This tags produce html-tables in the documentation


This is a source example where the new commands are used:
 @TabBegin
               Title 1         @I            Title 2         @I      Title 3
  @I______________________________________________
       row 1 column 1  @I   row 1 column 2   @I   row 1 column 3
  @I______________________________________________
       row 2 column 1  @I   row 2 column 2   @I   row 2 column 3
  @I______________________________________________
       row 3 column 1  @I   row 3 column 2   @I   row 3 column 3
  @I______________________________________________
       row 4 column 1  @I   row 4 column 2   @I   row 4 column 3
@TabEnd

Since more the one @I___-commands are defined it is possible to use 
short lines for small tables and long lines for tables with more columns.

May be it is a good idea to change the design of the aliases a little 
bit. For example it may be good to insert tag to write the headline in bold.

ALIASES     = "TabBegin = <TABLE><TR><TD><B>" \
                         "Ib        = </B></TD><TD><B>" \
                         "IbEnd        = </B>\

This is a source example where the new commands are used:

 @TabBegin
               Title 1         @Ib           Title 2        @Ib      
Title 3     @IbEnd
  @I______________________________________________
       row 1 column 1  @I   row 1 column 2   @I   row 1 column 3
  @I______________________________________________
       row 2 column 1  @I   row 2 column 2   @I   row 2 column 3
  @I______________________________________________
       row 3 column 1  @I   row 3 column 2   @I   row 3 column 3
  @I______________________________________________
       row 4 column 1  @I   row 4 column 2   @I   row 4 column 3
@TabEnd


Is there a special alias-archive with other examples like this?



Kind Regards,
                        Eckard Klotz.





>