diff options
| author | Paul Wicking <paul.wicking@qt.io> | 2024-04-18 13:35:32 +0200 |
|---|---|---|
| committer | Paul Wicking <paul.wicking@qt.io> | 2024-04-18 19:06:33 +0000 |
| commit | 938e9d1ccf5c76124f413b452cbe423b52a8de61 (patch) | |
| tree | b87930a403c1b495f42eed6301826aa538949e8c | |
| parent | 3258d378308886dbcc50fa4b8ab4b7abe7499a4a (diff) | |
QDoc: Update readme for end-to-end test
Add information about configuring output formats and location
information to the qdocconf section for new tests, as this can be
surprising or easily forgotten about.
Task-number: QTBUG-119500
Change-Id: Ie6fb7b8eabfa4483d777c0438755d8b93f651c48
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
| -rw-r--r-- | src/qdoc/qdoc/tests/validateqdocoutputfiles/README.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/README.md b/src/qdoc/qdoc/tests/validateqdocoutputfiles/README.md index 1c6438f4c..728cbee62 100644 --- a/src/qdoc/qdoc/tests/validateqdocoutputfiles/README.md +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/README.md @@ -50,6 +50,9 @@ project directory, otherwise the project won't be picked up by the test. ### The .qdocconf file The `.qdocconf` file contains the configuration necessary to build the QDoc project in the directory. Observe the following: +- **Important!** Make sure to set `locationinfo = false` to avoid test failures + due to differences in the location information in the generated output. +- Test projects should be warning free, so set `warninglimit.enabled = true`. - The name of the .qdocconf-file must be identical as that of the directory that contains it. This means that for a project **foo**, it should go into `testdata/foo` and the configuration file should be @@ -61,6 +64,13 @@ QDoc project in the directory. Observe the following: `include(bar.qdocconf)`, and this will work as expected. - The `warninglimit` should be set to the number of warnings expected from QDoc for that specific project, if any are to be expected at all. +- You probably want to configure all output formats, otherwise only the HTML + output will be generated. The test will compare all output formats that are + generated to the expected output, so remember to specify the output directory + for each format. By convention, the output directories are named after the + format, for example `html`, `docbook`, `webxml`, etc. +- Place the sources for your new test in a subdirectory of the test project + directory. By convention, the sources are placed in a directory named `src`. ### The `expected` directory The `expected` directory contains the expected output from QDoc |