diff options
| author | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-11-16 16:06:07 -0600 |
|---|---|---|
| committer | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-11-16 16:06:07 -0600 |
| commit | 5fbf99bcc4d03f3001f42905d1217758c4aeac13 (patch) | |
| tree | b61aa3fd6d7b0e8302a8b11a18ef2cab5f404951 /doc/tdevelop/documentation.docbook | |
| parent | 06c48bfff719dedfe6f271fe5a363453e4af6d31 (diff) | |
| download | tdevelop-5fbf99bcc4d03f3001f42905d1217758c4aeac13.tar.gz tdevelop-5fbf99bcc4d03f3001f42905d1217758c4aeac13.zip | |
Finish rename from prior commit
Diffstat (limited to 'doc/tdevelop/documentation.docbook')
| -rw-r--r-- | doc/tdevelop/documentation.docbook | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/tdevelop/documentation.docbook b/doc/tdevelop/documentation.docbook new file mode 100644 index 00000000..2214fed3 --- /dev/null +++ b/doc/tdevelop/documentation.docbook @@ -0,0 +1,57 @@ +<chapter id="documentation"> +<title>Documentation</title> + +<para> +Documention unfortunately belongs to the most-overlooked programming +issues. Yet, once properly set up and maintained internal and external +documentation provides most valuable help. +</para> + +<para> +Documentation has multiple facets. There is +<itemizedlist> + <listitem><para> + <emphasis>project internal documentation</emphasis>, mainly consisting of + <itemizedlist> + <listitem><para> + <emphasis>comments</emphasis> in header/source files + </para></listitem> + <listitem><para> + <emphasis>internal &API; documentation</emphasis> of your project + generated from the program file by special tools, ⪚ &doxygen; + </para></listitem> + </itemizedlist> + </para></listitem> + <listitem><para> + <emphasis>project external documentation</emphasis>, comprising among others + <itemizedlist> + <listitem><para> + <emphasis>external &API; documentation</emphasis> of ⪚ common system libraries (&kde;, &Qt;, &etc;) + </para></listitem> + <listitem><para> + any other documentation (programming language manuals, general system information, how-to articles and the like) + </para></listitem> + </itemizedlist> + </para></listitem> +</itemizedlist> +</para> +<para> +All this documentation should be easily maintainable and ready at hand whenever you need it. &tdevelop; has provisions for just this. +</para> + +<!-- ### doc browser, notes on internal documentation, how to profit from Doxygen --> + +<sect1 id="docbrowser"> +<title>The Documentation Browser</title> + + +<figure id="screenshot-doctreeview" float="1"> +<title>A Screenshot of the Documentation Tree</title> +<mediaobject> +<imageobject><imagedata fileref="doctreeview.png"/></imageobject> +</mediaobject> +</figure> + +</sect1> <!-- docbrowser --> + +</chapter> <!-- documentation --> |