summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorPhilip Withnall <philip@tecnocode.co.uk>2010-03-27 16:21:19 +0000
committerPhilip Withnall <philip@tecnocode.co.uk>2010-03-27 16:22:20 +0000
commit7b79b7da769d96aacb182e684a4b85b3bb0140c5 (patch)
treeeeecbe0e70402a56db54db61dc37bb7af9265ff0 /HACKING
parent09022c450b40178782016036391d60973a7dba72 (diff)
downloadlibgdata-7b79b7da769d96aacb182e684a4b85b3bb0140c5.tar.gz
[docs] More documentation warning fixes
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING3
1 files changed, 2 insertions, 1 deletions
diff --git a/HACKING b/HACKING
index 846febc5..16676f44 100644
--- a/HACKING
+++ b/HACKING
@@ -75,7 +75,8 @@ libgdata employs:
* @updated_max: the new maximum update time, or %NULL
- - If numbers, such as %-1, are mentioned in documentation as values to be passed around in code, they should be prefixed by a '%', just like %NULL.
+ - If numbers, such as -1, are mentioned in documentation as values to be passed around in code, they should be wrapped in a DocBook "code" tag
+ (e.g. "<code class="literal">-1</code>"), so that they appear similarly to NULL in the documentation.
- The documentation explaining the purpose of a property, its limitations, interpretation, etc., should be given in the gtk-doc comment for the
GObject property itself, not in the documentation for its getter or setter. The documentation for the getter and setter should be stubs which