Browse files

- docbook/item-skel/* files: templates for symbols documentation

- images/: added home.gif and up.gif (should be .png once later)
- refs/post_page/synopsis: how did this slip through uncommited before
  • Loading branch information...
1 parent c8b5f11 commit 18d5d629626c4016bc0293e20f4a3e7df9e08d1f @docelic docelic committed Jul 21, 2004
View
2 docbook/item-skel/bugs
@@ -0,0 +1,2 @@
+<!-- List bugs here. Environment is <para>.
+ Delete those two lines. -->
View
22 docbook/item-skel/control
@@ -0,0 +1,22 @@
+# The usual comments can be used here.
+# To override a field, supply a value
+# To let it through unmodified, simply leave the fields empty
+
+# purpose: oneline description (MUST FILL IN)
+purpose:
+# Please take time to fill in the See Also line.
+# Just name the related symbols. The system will work everything out.
+# (Note that if you link some item from here, that item will auto-point
+# back here (under "indirect links" section))
+see also:
+
+# Usually not needed to modify below
+
+# id: name of the output file (defaults to <name>)
+id:
+# name: visible name in the pages
+name:
+# specify person(s). Defaults to icdevgroup
+author:
+# leave empty; GPL is the default
+copyright:
View
2 docbook/item-skel/description
@@ -0,0 +1,2 @@
+<!-- Enter description here. Context is <para>.
+ Delete those two lines -->
View
16 docbook/item-skel/example
@@ -0,0 +1,16 @@
+<!-- Template example. Fill in the title (in title), short description
+ (in para) and actual program chunk (inside listing/cdata).
+ Delete those 3 lines of comments. -->
+
+<example>
+
+<title>
+</title>
+
+<para>
+</para>
+
+<programlisting><![CDATA[
+]]></programlisting>
+
+</example>
View
1 docbook/item-skel/notes
@@ -0,0 +1 @@
+<!-- Add notes or delete this line -->
View
14 docbook/item-skel/synopsis
@@ -0,0 +1,14 @@
+<!-- Synopsis is a CDATA block (it's <pre>formatted), so you're pretty
+ much free to construct the synopsis any way you want. Try to keep it
+ along the lines of (if not describing Tags for which this scheme is
+ not usable:
+
+ literal - literal text
+ <text> - mandatory value
+ [text] - optional text
+
+ Describe various options inside 'description' file.
+ Delete those comment lines -->
+
+<synopsis><![CDATA[
+]]></synopsis>
View
BIN images/home.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN images/up.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
3 refs/post_page/synopsis
@@ -0,0 +1,3 @@
+<synopsis><![CDATA[
+Pragma post_page=<subroutine name>
+]]></synopsis>

0 comments on commit 18d5d62

Please sign in to comment.