Ticket #24 (closed enhancement: fixed)

Opened 15 years ago

Last modified 15 years ago

Organization, clean up and wiki-based documentation of the whole directory

Reported by: mido Owned by: mido
Priority: blocker Milestone:
Component: bdm core Version:
Keywords: Cc: smidl@…, miroslav.pistek@…

Description

At the moment, structure of the whole directory is not much intuitive. For a new user, it is quite complicated to get used to it. It would be helpful to clean it up a bit and prepare a wiki page with some basic infromation where to find existing files and where to add new files.

Change History

  Changed 15 years ago by mido

The work progress will be described here.

  Changed 15 years ago by mido

  • status changed from new to assigned

follow-up: ↓ 4   Changed 15 years ago by smidl

Wiki is OK when on-line, but Doxygen works both no- and off-line.

I would prefer a page in /doc/local

It can be linked from the main page in trac.

in reply to: ↑ 3   Changed 15 years ago by mido

Replying to smidl:

Wiki is OK when on-line, but Doxygen works both no- and off-line. I would prefer a page in /doc/local It can be linked from the main page in trac.

Good point. A new file /doc/local/library_structure.dox is to be commited. All the notes concerning the library structure should be found there and also it should be continously updated.

  Changed 15 years ago by smidl

  • cc smidl@…, miroslav.pistek@… added

  Changed 15 years ago by mido

  • priority changed from major to blocker
  • status changed from assigned to closed
  • resolution set to fixed
Note: See TracTickets for help on using tickets.