Opened 17 years ago
Closed 16 years ago
#249 closed defect (invalid)
Document all code
Reported by: | bknecht | Owned by: | everybody |
---|---|---|---|
Priority: | blocker | Milestone: | Version 0.2 Codename: Bellatrix |
Component: | Doxygen | Version: | 0.2.0 |
Keywords: | pain_in_the_ass | Cc: | |
Referenced By: | References: |
Description
Outline
Not everything is documented in Orxonox. This is bad, since we have a a lot of changes with the developers and undocumented code is shit to read. Just try it once and you will never want to do it to anybody.
Starting point
We have a nice [doxygen Doxygen-Plugin] in our Trac. There you can check out what is already documented and what needs to be better.
How to start
While working you should document your code and find parts of code which are poorly documented. While working with that other code, why not improve its documentation.
Goal
Have well documented code at the end of the semester.
Change History (1)
comment:1 Changed 16 years ago by rgrieder
- Resolution set to invalid
- Status changed from new to closed
Note: See
TracTickets for help on using
tickets.
This cannot be a ticket. This is something you have to tell everyone and oneself a thousand time.