/usr/share/GNUstep/Documentation/User/GNUstep/gnustep-faq/Helping-document-GNUstep.html is in gnustep-make-doc 2.6.8-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Untitled Document: Helping document GNUstep</title>
<meta name="description" content="Untitled Document: Helping document GNUstep">
<meta name="keywords" content="Untitled Document: Helping document GNUstep">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Compiling-and-Developing.html#Compiling-and-Developing" rel="up" title="Compiling and Developing">
<link href="How-do-I-assign-my-contribution_003f.html#How-do-I-assign-my-contribution_003f" rel="next" title="How do I assign my contribution?">
<link href="Helping-develop-GNUstep.html#Helping-develop-GNUstep" rel="prev" title="Helping develop GNUstep">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en">
<a name="Helping-document-GNUstep"></a>
<div class="header">
<p>
Next: <a href="How-do-I-assign-my-contribution_003f.html#How-do-I-assign-my-contribution_003f" accesskey="n" rel="next">How do I assign my contribution?</a>, Previous: <a href="Helping-develop-GNUstep.html#Helping-develop-GNUstep" accesskey="p" rel="prev">Helping develop GNUstep</a>, Up: <a href="Compiling-and-Developing.html#Compiling-and-Developing" accesskey="u" rel="up">Compiling and Developing</a> </p>
</div>
<hr>
<a name="Helping-document-GNUstep-1"></a>
<h4 class="subsection">1.2.4 Helping document GNUstep</h4>
<p>All class documentation is written directly in the source code itself
and translated using the autogsdoc program. See the source code and
documentation for autogsdoc for information on documenting the classes.
</p>
<p>Newcomers could write documentation for individual classes by
comparing the OpenStep specification, the MacOS-X documentation,
and the GNUstep source. Documentation should clearly note where
individual methods are specific to OpenStep, MacOS-X or are GNustep
extensions.
</p>
<p>More experienced people could write documentation on general
programming topics, and tutorials for new users.
</p>
<p>Anyone willing to write documentation, either tutorials for using
GNUstep, or reference documentation for individual classes, should
either write it in gsdoc or as plain ascii text for someone else to
format into gsdoc.
</p>
<p>GNUstep documentation should have copyright assigned to the Free
Software Foundation.
</p>
</body>
</html>
|