diff options
| author | Topi Reinio <topi.reinio@digia.com> | 2015-05-08 09:54:05 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@digia.com> | 2015-05-08 08:31:21 +0000 |
| commit | a86b26db777930cd6ad037e64b22ac4fa2726d1d (patch) | |
| tree | bfdc0aa9165b40a3612552a5f52b97a4306c527d /doc/operations.qdoc | |
| parent | e348b710240c1db744ef1a3b897dd5ebd7818a2f (diff) | |
Doc: Fix layout issues on the operations table
Replace a \code block with a monospace \c text, and unintended
'\n' sequences with spaces, allowing the text to span multiple
lines.
These changes make the table more readable by reducing its
width and avoiding the creation of a scrollbar.
Change-Id: Iff87fe2fe1b017e88395701643d278cb868e7f04
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Diffstat (limited to 'doc/operations.qdoc')
| -rw-r--r-- | doc/operations.qdoc | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/doc/operations.qdoc b/doc/operations.qdoc index f2b8c5531..ab760bb28 100644 --- a/doc/operations.qdoc +++ b/doc/operations.qdoc @@ -114,10 +114,8 @@ In addition, a special argument, UNDOEXECUTE, separates the DO step of the operation from the UNDO step. - example: - \code - component.addOperation("Execute", "touch", "test.txt", "UNDOEXECUTE", "rm", "test.txt") - \endcode + Example: + \c{component.addOperation("Execute", "touch", "test.txt", "UNDOEXECUTE", "rm", "test.txt")} \row \li CreateShortcut \li "CreateShortcut" \c filename \c linkname [\c arguments] @@ -127,7 +125,7 @@ \c arguments. On Unix, this creates a symbolic link. \row \li CreateDesktopEntry - \li "CreateDesktopEntry" \c filename \c "key=value[\nkey2=value2[\nkey3=value3]]]" + \li "CreateDesktopEntry" \c {filename "key=value[ key2=value2[ key3=value3]]]"} \li Creates a .desktop initialization file, as specified by freedesktop.org. @@ -173,7 +171,7 @@ registry) or by \c application and \c company name. Set \c scope to "SystemScope" to create an entry in the system scope. - \note: The operation is using QSettings to store the key value pair. QSettings + \note The operation is using QSettings to store the key value pair. QSettings always treats backslash as a special character and provides no API for reading or writing such entries. Do not use slashes ('/' and '\') in section or key names; the backslash character is used to separate sub keys. On windows, '\' are converted |