diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2017-02-03 15:33:18 +0100 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@qt.io> | 2017-02-07 08:36:00 +0000 |
| commit | e4b3e47935bcab5abecc156d526836ef584f69e2 (patch) | |
| tree | 29478c50bf927a7abd66cfbd2bddae4065a4e709 /doc/global/config.qdocconf | |
| parent | 8c31f75fd31d2d83de557c0d5fb15edb384f8933 (diff) | |
Doc: Add a comment into config.qdocconf about generating internal docs
QDoc supports the --showinternal command line option, but it's
not integrated to the build system.
This commit documents an alternative way to get documentation marked as
internal generated, replacing every instance of \internal with a text
string '[internal]'
Change-Id: Ib48ade21adf32d430e62b95c4baa64be620d7eb0
Reviewed-by: Andy Shaw <andy.shaw@qt.io>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'doc/global/config.qdocconf')
| -rw-r--r-- | doc/global/config.qdocconf | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/global/config.qdocconf b/doc/global/config.qdocconf index 0c22d70529..a18396876d 100644 --- a/doc/global/config.qdocconf +++ b/doc/global/config.qdocconf @@ -13,3 +13,7 @@ navigation.homepage = "Qt $QT_VER" sourcedirs += includes $$BUILDDIR url = http://doc.qt.io/qt-5 + +# Uncomment the following two lines to generate documentation marked as \internal +# alias.internal = disable +# macro.internal.HTML = "<span style="color:red">[internal]</span>" |