From f4092abdf94af6a99aff944d6264bc1284e8bdd4 Mon Sep 17 00:00:00 2001 From: Reinhard Tartler Date: Mon, 10 Oct 2011 17:43:39 +0200 Subject: Imported nx-X11-3.1.0-1.tar.gz Summary: Imported nx-X11-3.1.0-1.tar.gz Keywords: Imported nx-X11-3.1.0-1.tar.gz into Git repository --- .../ogl-sample/main/doc/man/mangl/standard/RULES | 89 ++++++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 nx-X11/extras/ogl-sample/main/doc/man/mangl/standard/RULES (limited to 'nx-X11/extras/ogl-sample/main/doc/man/mangl/standard/RULES') diff --git a/nx-X11/extras/ogl-sample/main/doc/man/mangl/standard/RULES b/nx-X11/extras/ogl-sample/main/doc/man/mangl/standard/RULES new file mode 100644 index 000000000..e6871911d --- /dev/null +++ b/nx-X11/extras/ogl-sample/main/doc/man/mangl/standard/RULES @@ -0,0 +1,89 @@ +Rules for Open GL man pages: + + * Describe commands that differ only by a suffix on the same + page. Do this regardless of whether the commands take the + same or different arguments. For example, all 24 Vertex + commands are described on one page. + + Issue - current tools like to separate v and non-v commands. + + * Describe commands that operate in obvious pairs on the same + page. For example, Begin and End, or PushMatrix and PopMatrix. + + * Use the _header(desc) macro to begin a manpage. Write the + 1-line command description "desc" using the imperative tense. + For example: + + _header(Operate on the accumulation buffer) + + not + _header(Operates on the accumulation buffer) + + * The order of the entries on a manpage is + + header + PARAMETERS (unless the command takes no parameters) + DESCRIPTION + EXAMPLE (optional) + ERRORS (optional) + SEE ALSO + BUGS (optional) + NOTES (optional) + + * Use the _phead(param) macro to describe each parameter or + group of parameters. + + * Begin the description of in-only parameters with the phrase + "Specifies". + + * Begin the description of out-only parameters with the phrase + "Returns". + + * Begin the description of in-and-out parameters with the + phrase "Specifies and returns". If there is a difference + between what is specified and what is returned, use two + paragraphs for the description, the first beginning with + "Specifies" and the second beginning with "Returns". + + * Group like parameters into a single description. For example + "x,y Specify the x and y coordinates ...", or + "r,g,b Return the red, green, and blue color values ..." + + Possible tools issue. + + * Include the default value in the description of parameters + that directly specify GL state. + + * Refer to parameters using the _param# macro, never explicitly + by name. Note that this rules out clever English tricks that + count on the macro evaluating to a particular string. For + example, one cannot say "The second parameter is a floating + point _param2", where it is expected that _param2 will evaluate + to the string "value". + + * Use _cmnd to refer to the command being described. + + * Use _cmnd(basename) to refer to another command. Note that + basename does not include any prefix, it is added automatically + by the _cmnd() macro. + + * Use _const(basename) to refer to a constant. Note that + basename does not include any prefix, it is added automatically + by the _const() macro. + + * Use _hex(value) to refer to a hexidecimal value. + (This should not be required very often in the Open GL.) + + * List commands in the see also section in alphabetical order. + Include commands that return all the state that is set by + the command being documented. + +Limitations of the alpha release: + + * The header, command syntax, parameter descriptions, and see + also sections will be complete. + + * The command description may not be complete, but it will at + least exist. + + * The example section may not exist. -- cgit v1.2.3