Task #55

Improve source code documentation

Added by Radegast over 6 years ago. Updated over 1 year ago.

Status:New% Done:

50%

Priority:Low
Assignee:Aranud
Category:General
Target version:ALL
OS: Arch:

Description

The code is filled with obfuscate comments and developer "signatures". Replace all of it with well-structured Doxygen comment blocks and supporting documentation in the Redmine wiki.

Incorporate doxygen into the ET:L website and make it update upon each new commit.

Move info from the Redmine wiki and create separate sections for:

Console commands
CVARS
Lua API
...

Related issues

Related to ET: Legacy Development - Task #610: Improve source code documentation Invalid 06.11.2014

Associated revisions

Revision 947d1483
Added by Radegast over 5 years ago

misc: comment clean up, refs #55

Revision 2700612b
Added by Radegast over 5 years ago

misc: comment clean up (baseq3 → etmain), refs #55

Revision 29b085a4
Added by Radegast over 5 years ago

misc: comment clean up, refs #55

Revision f8e08cd6
Added by Aranud almost 2 years ago

cgame: fix clang warning + Doc refs #55

Revision 5d8afe0f
Added by Aranud almost 2 years ago

cgame: fix clang warning + doc refs #55 + uncrustify

Revision 48f61789
Added by Aranud almost 2 years ago

cgame: fix clang warning + doc refs #55

Revision aa1bd8d0
Added by Aranud almost 2 years ago

cgame: fix clang warning + doc refs #55

Revision 43a4093b
Added by Aranud almost 2 years ago

cgame: fix clang warning + docs refs #55

Revision a1080a7c
Added by Aranud almost 2 years ago

cgame: fix clang warning + doc refs #55

Revision e040c2a5
Added by Aranud almost 2 years ago

ui: fix clang warning + tiny optimisation + doc refs #55

Revision 77fef1f2
Added by Aranud almost 2 years ago

sys: fix clang warning + Doc refs #55

Revision 4dcd2a6f
Added by Aranud almost 2 years ago

server: fix clang warning + doc refs #55

Revision 47e0e29b
Added by Aranud almost 2 years ago

server: fix clang warning + docs refs #55

Revision 7acdd9a8
Added by Aranud almost 2 years ago

sdl: fix clang warning + docs refs #55

Revision 1864f5ed
Added by Aranud almost 2 years ago

db: doc refs #55

Revision 9fa09428
Added by Aranud almost 2 years ago

botlib: fix clang warning + comment used function + doc refs #55

Revision 731e1c51
Added by Aranud almost 2 years ago

client: fix clang warning + doc refs #55

Revision 15350088
Added by Aranud almost 2 years ago

client: fix clang warning + doc refs #55

Revision 6bb78d9d
Added by Aranud almost 2 years ago

client: doc refs #55

Revision 3cf75c9e
Added by Aranud almost 2 years ago

game: fix clang warning + doc refs #55

Revision 3cdd6c8f
Added by Aranud almost 2 years ago

game: fix clang warning + doc refs #55

Revision 16994e9b
Added by Aranud almost 2 years ago

game: fix clang warning + doc refs #55

Revision 470b1ac9
Added by Aranud almost 2 years ago

game: fix clang warning + doc refs #55

Revision f97fdec7
Added by Aranud almost 2 years ago

game: fix clang warning + doc refs #55

Revision 78d7d7aa
Added by Aranud almost 2 years ago

game: fix clang warning + doc refs #55

Revision 2da428a7
Added by Aranud almost 2 years ago

game: fix clang warning + docs refs #55

Revision 3dfb103b
Added by Aranud almost 2 years ago

omnibot: fix clang warning + doc refs #55

Revision 3b620411
Added by Aranud almost 2 years ago

null: doc refs #55

Revision d2f56b16
Added by Aranud almost 2 years ago

qcommon: fix clang warning + docs refs #55

Revision b64e41bc
Added by Aranud over 1 year ago

renderer: doc refs #55 + tinys changes

Revision 68fbf245
Added by Aranud over 1 year ago

rendererGLES: doc refs #55 + tinys changes

Revision 78dff3d1
Added by Aranud over 1 year ago

renderercommon: doc refs #55 + tinys changes

Revision 12eea4af
Added by Aranud over 1 year ago

renderercommon: doc refs #55 + tiny changes

Revision 7af4d4b2
Added by Aranud over 1 year ago

renderer2: doc refs #55 + tiny changes

Revision b204a8be
Added by Aranud over 1 year ago

renderer2: docs refs #55 + tiny changes

Revision e53f9239
Added by Aranud over 1 year ago

renderer2: docs refs #55 + tiny changes

Revision b21c09b6
Added by Aranud over 1 year ago

server: doc refs #55

Revision 2c977be0
Added by Aranud over 1 year ago

botlib: doc refs #55

Revision f5e4e2ec
Added by Aranud over 1 year ago

client: doc refs #55

Revision 9ac036f9
Added by Aranud over 1 year ago

cgame: doc refs #55

Revision b572359d
Added by Aranud over 1 year ago

cgame: doc refs #55

Revision 0e91501f
Added by Aranud over 1 year ago

game: doc refs #55

Revision 6746db50
Added by Aranud over 1 year ago

ui: doc refs #55

Revision f1d048da
Added by Aranud over 1 year ago

general: fix ton of doc warning refs #55

Revision 1a9892da
Added by Aranud over 1 year ago

irc: doc refs #55

Revision 299f36b0
Added by Aranud over 1 year ago

general: fix doc warning refs #55

Revision 084d0d66
Added by Aranud over 1 year ago

qcommon: doc refs #55

Revision 39ce5d72
Added by Aranud over 1 year ago

server: doc refs #55

Revision fb7b9a84
Added by Aranud over 1 year ago

renderer: doc refs #55

Revision 792b6fb2
Added by Aranud over 1 year ago

common: doc refs #55

History

#1 Updated by Radegast about 6 years ago

  • Assignee deleted (Radegast)
  • Target version changed from 2.75 to ALL

#2 Updated by IR4T4 about 3 years ago

  • Description updated (diff)

#3 Updated by IR4T4 about 3 years ago

  • Related to Task #610: Improve source code documentation added

#4 Updated by IR4T4 over 1 year ago

  • Assignee set to Aranud
  • Target version changed from ALL to 2.76
  • % Done changed from 10 to 50

#5 Updated by IR4T4 over 1 year ago

  • Target version changed from 2.76 to ALL

Also available in: Atom PDF