bugTransport Sample Protocol - Bugs: bug #2344, TSP doxygen generated doc is poor...

 
 

bug #2344: TSP doxygen generated doc is poor and non-gnu

Submitted by:  Eric NOULARD <erk>
Submitted on:  Tue 21 Jan 2003 01:18:21 PM UTC  
 
Category: CoreSeverity: 1 - Wish
Status: FixedPrivacy: Public
Assigned to: Eric NOULARD <erk>Open/Closed: Closed
Release: NoneFixed Release: None

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

Tue 01 Nov 2005 12:28:06 PM UTC, comment #2:

All images are now png and no gif.
Headers and Footer are now acceptable.
I did update the doxygen config file
using doxywizard.

We now need a full review of the API documentation.
I close the 'bug' and open a doc task since
this is no more a bug.

Eric NOULARD <erk>
Project AdministratorIn charge of this item.
Wed 22 Jan 2003 01:23:07 PM UTC, comment #1:

The doc generation have been improved.
Generally speaking we should use the grouping facility of
doxygen in order to make the documentaion easily readable
from a module point of view.

I defined 5 modules:
Core
Core::Provider
Core::Provider::Server
Core::Consumer
Core::Consumer::Client

We should discuss the identifed module from a design
point of view, this way it would be easier to understand
the TSP design independently of the source layout.

I keep the bug Open till a firm choice on TSP module
has been globally accepted.

Eric NOULARD <erk>
Project AdministratorIn charge of this item.
Tue 21 Jan 2003 01:18:21 PM UTC, original submission:

The doc generated by doxygen is (very) poor
(should respect a documentaion pattern at least for the
consumer and provider API)

The header and footer use gif
we should use png:
http://burnallgifs.org/
http://www.tuxedo.org/~esr/gif2png/
http://lignes.ringard.org/linux/png.html

Some typo in header.html and footer.html
have nothing to do with TSP.

Eric NOULARD <erk>
Project AdministratorIn charge of this item.

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

CC list is empty

 

Do you think this task is very important?
If so, you can click here to add your encouragement to it.
This task has 0 encouragements so far.

Only logged-in users can vote.

 

Please enter the title of George Orwell's famous dystopian book (it's a date):

 

 

Follow 9 latest changes.

Date Changed By Updated Field Previous Value => Replaced By
Tue 01 Nov 2005 12:28:06 PM UTCerkStatusNone=>Fixed
  Assigned toNone=>erk
  Open/ClosedOpen=>Closed
Wed 04 Feb 2004 11:38:49 AM UTCdufySeverity2 - Minor=>1 - Wish
Wed 04 Feb 2004 11:37:22 AM UTCdufySeverity3 - Normal=>2 - Minor
  Assigned toerk=>None
Wed 22 Jan 2003 10:01:55 AM UTCerkCategoryNone=>(Error - Not Found)
  Item GroupNone=>(Error - Not Found)
Tue 21 Jan 2003 02:28:13 PM UTCerkAssigned toNone=>NA

Back to the top


Powered by Savane 3.1-cleanup1