Opened 19 months ago

Last modified 7 weeks ago

#1091 new enhancement

Document rasdaman top-level directories

Reported by: dmisev Owned by: dmisev
Priority: major Milestone: Future
Component: wiki Version: development
Keywords: Cc: pbaumann, atoader, vmerticariu, gmerticariu, mdumitru
Complexity: Medium

Description

We need to clearly document what the role of each directory with code in rasdaman is and how it relates with the rest. There are many directories and it is often confusing and intimidating for newcomers without some documentation.

Is there some usual standard way to do this? In Java we'd have package.html or so; I'm not sure about autotools managed projects.
How about putting a README or similar file in each directory for this purpose? With a simple script we can collect these descriptions and generate a wiki page content for overview.

Change History (4)

comment:1 Changed 19 months ago by dmisev

Actually we are using doxygen if --with-docs is specified, so it would be best to document directories in a way compliant with doxygen.

comment:3 Changed 5 months ago by dmisev

  • Milestone changed from 9.2 to 9.4

comment:4 Changed 7 weeks ago by dmisev

  • Milestone changed from 9.4 to Future
Note: See TracTickets for help on using tickets.