summaryrefslogtreecommitdiff
path: root/ostable
diff options
context:
space:
mode:
authorGuillem Jover <guillem@debian.org>2010-11-01 06:13:38 +0100
committerGuillem Jover <guillem@debian.org>2010-11-19 05:21:14 +0100
commitec5d6813398a42b6cf6b3da7604e59bbb3343aa9 (patch)
tree0927f4865391631a683a75db3ea0c609b2f08cff /ostable
parent9209010455812b6e51cd907aab3d50779ea8e35b (diff)
downloaddpkg-ec5d6813398a42b6cf6b3da7604e59bbb3343aa9.tar.gz
Cleanup and improve source code comments
Global review, which includes the following changes to try to increase consistency, update and improve the source code comments: - Spelling fixes. - Use American English forms. - Uppercase NULL, NUL and ASCII. - Use “Note: ” instead of the slightly cryptic “NB: ” form. - Write comments as proper sentences, including capitalizations and ending dots. - Move comments before the code, function or variable they refer to. - Move general function comments outside the body. - Convert function and variable description comments to doxygen. - Use one space before dot, exclamation and question marks. - Use ‘’ or “” instead of `' style quoting. - Remove author names from comments, already visible from “git blame”. - Mark strings for translators with “TRANSLATORS: ”. - Remove useless or outdated comments. - Fix comment indentation. - Standardize comment format: /* Short text comment. */ /* Long text, * comment. */ /* * Section text. */
Diffstat (limited to 'ostable')
0 files changed, 0 insertions, 0 deletions