Writing Qt Documentation

From Qt Wiki
Revision as of 18:11, 14 January 2015 by Maintenance script (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Writing Qt Documentation

This document contains some documentation style guidelines that have been used when documenting Qt over the past few years.

It may be helpful to refer to the online qdoc manual [doc.qt.digia.com].

See Building_Qt_Documentation for instructions on the usual way to build the Qt documentation.

See Troubleshooting Qt Documentation for advice on what to look for if your documentation is not processed correctly by qdoc.

See Developing Qt Documentation [qt.io] for information about the documentation process.
h2. API documentation

General

  • Write complete sentences for \value items in \enum lists.
  • Use only real URLs if absolutely necessary, otherwise use “http://example.com”. Use \externalpage documents to create fake pages for external documents that you can refer to by title.
  • Indent using spaces, not tabs.

Use of language

  • Hyphenation is not normally needed nor used.
  • Shorthand is discouraged.
    • For example, “and” should be used in preference to “&” unless there is a very good reason.
  • Each word in a title (either a page title or a section title) should start with an upper case letter, except for the most common prepositions [en.wikipedia.org] (of, to, in, for, with and on) and coordinating conjunctions [en.wikipedia.org] (for, and, nor, but, or, yet, and so).
    • For example, “Anchor Margins and Offsets” not “Anchor margins and offsets” (lower case is wrong) or “Anchor Margins And Offsets” (“and” should be lower case).

Overview/modules

  • Shows/describes how classes in the module are used together.
  • Describes the main concepts and features of groups of classes.

Class descriptions

  • Brief overview
  • Start the main body of text with something like, “A <plain language name> is a…”
  • Alternative classes, e.g.
    • QTable / QListView
    • QListBox / QComboBox
    • QDial / QSlider / QSpinBox
  • Patterns of use
    • Minimal
    • Realistic: quotes from snippets in the doc directory, and examples in the qt/examples directory
  • Concepts; e.g.
    • QTextEdit: lines vs. paragraphs
    • In Qt 3, QCanvas is abstract; QCanvasView actually displays the canvas
  • Details
    • Describes and groups together functions with common features

Some examples of Qt documentation:

  • QString [doc.qt.digia.com] covers the use cases but is a little too technical at the start.
  • QDir [doc.qt.digia.com] is an example of a newer style where we used titles to split up different use cases.
  • QMenu [doc.qt.digia.com] is brief, but to the point, though it could use some code examples.
  • QDialog [doc.qt.digia.com] cover various important concepts but should really address the practicalities of subclassing QDialog to implement your own dialog.
  • QPushButton [doc.qt.digia.com] is a reasonable example of documentation for a simple widget.
  • QGraphicsScene [doc.qt.digia.com] is OK but could really use some code examples.
  • QPainter [doc.qt.digia.com] is quite good at showing what the class does (in the documentation for the functions), but the main description tends to contain lists of functions. A lot of that should have been moved into an overview, in my opinion.

I’m sure I haven’t found the “best” examples of documentation. These are just a few cases that I didn’t consider to be in need of radical improvement.

The guidelines I learned basically followed the “pyramid” approach of providing a bit of simple information, then some more detailed information, followed by even more complex information about each class.

  1. Describe what the class is/does.
  2. Refer the reader to other relevant classes or documents describing the concepts.
  3. Show a simple use case, if possible.
  4. Describe the features, beginning with the simplest, most commonly used ones, showing relevant, simple code snippets. Try to group these into categories.
  5. Describe more complex features that may involve interaction with other classes.
  6. Discuss subclassing if relevant, and describe what the developer needs to take care of when doing this.
  7. Put links to relevant documents, perhaps in a section of their own, but at least in a see-also line at the end of the detailed description.

There should, of course, be links to functions/methods and other classes throughout. Images are also good to include, either in terms of showing what a widget looks like or to illustrate a concept.

Function descriptions

  • \brief descriptions:
    • Property descriptions should start with a lower case letter and have no ending period.
    • Class descriptions should be complete sentences.
  • Constructors should read something like, “Constructs the … with the given \a parent.”
  • Introduce arguments/parameters using the following two phrases:
    • … is specified by …
    • … in the given …
  • Do not use
    • … is given by …

Use of parameter names

Don’t use natural language phrases that make the operation ambiguous:

Sets the value of the treasure.

It would be better to write something explicit:

Sets the value of the treasure to value.

The above use relies on a coincidence between the action on the instance and
the value to use. It could also give the impression that value is
changed in some way.

Avoid overspecifying definitions:

Constructs a new widget with name name and parent parent.

Maybe something like the following would be acceptable:

Constructs a new widget with the given name and parent.

Don’t change commonly used parameter names to suit local documentation requirements:

Sets the bounding rectangle of the widget.

The original rect parameter should not be renamed to rectangle.
Instead we would write something explicit:

Sets the bounding rectangle of the widget to rect.

Miscellaneous

  • Use \omit and \endomit to omit sections from the documentation.
    • Remember that they are still present in the documentation source text.
  • Use \omitvalue to omit enum values from the documentation, but still allow qdoc to process them without complaint.

Style of example code

See WritingQtExamples for more detailed guidance about writing and documenting examples.

Objectives

Examples should be

  • Simple
  • Bland (not necessarily)
  • Cover the key concepts

In header files

  • Give parameter names for used parameters.
  • Write declared variables of the same type on separate lines.
  • No underscores in names.
  • Only include header files that are absolutely necessary.

In C++ files

  • Order of actions in the constructor:
    • Create each widget and set options for it.
    • Set the connections.
    • Create layout and insert items.
    • Set the title of top-level widgets with setWindowTitle().
  • Accelerators and translations
    • Use translation strings rather than hardcoded accelerator flags; e.g. tr(“Ctrl+Q”) rather than CTRL + Key_Q
    • Note that Qt provides enum values for standard shortcuts [doc.qt.digia.com] which should be used in preference
  • Comments:
    • Introductory comment for each file. What the file is for.
    • No comments where the purpose of the code is clear.
    • General comments about functions go outside the function in a multiline comment.
    • What: the code itself.
    • Why: reason something is needed – high level. (Outside function.)
    • How: the way these actions are performed. (Outside function.)

Variable naming

From a commit message made on 2004/05/28 16:08:34:

<pre> Renamed some “flag enum” types to be more consistent (i.e. the enum type associated to a flag type through Q_DECLARE_FLAGS).

Usually, the enum type isn’t used directly; only the flags type is. Still, sometimes we do use it, and then it’s important to have a good name. Also, the documentation shows that name. The rule I’ve tried to follow were: 1. If the flags type is a plural (e.g. Options, Actions, Flags), make the enum type a singular (e.g. Option, Action, Flag). 2. Otherwise, make the enum type by appending “Flag” to the flags type (e.g. Alignment is the flags type, AlignmentFlag is the enum type). Notice that “Flag” is a singular. This is because an enum of that type can only store one flag at a time (whereas a variable of the “flags” type can store many). </pre>

Documentation structure

  • Necessary files to build the example.
  • Overview document (to be converted by qdoc to some other format).

[toc align_right=

Categories:
https://wiki.qt.io/index.php?title=Writing_Qt_Documentation&oldid=2303
wiki.qt.io
crawl=CC-MAIN-2022-33
30105
application/http; msgtype=response
sha1:PKLM2Y5HVKR2FGBEVKDKV7P6F5J6D67S
<urn:uuid:6c4ece6e-2019-4c5b-a144-28a4d0dcb141>
2022-08-15T18:58:57Z
54.73.26.109
text/html
sha1:5MJQNQQDJRNXG7SKO4GBIKYFJXG7IXXE
<urn:uuid:bbb55945-e92f-4f94-8d0f-bb914a95482b>
https://wiki.qt.io/index.php?title=Writing_Qt_Documentation&oldid=2303
response
<urn:uuid:d86cb81b-83eb-4212-8e49-afe75e665ee3>
isPartOf: CC-MAIN-2022-33
publisher: Common Crawl
description: Wide crawl of the web for August 2022
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-76
software: Apache Nutch 1.18 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.4-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/