[SYCL] Improve Doxygen documentation UX #1201
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Fix classes missing due to inline namespace macro. - Enable first sentence as brief. - Make diagrams clickable. Signed-off-by: Alexander Batashev <alexander.batashev@intel.com>
bader
approved these changes
Feb 26, 2020
|
|
||
| # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first | ||
| # line (until the first dot) of a Qt-style comment as the brief description. If | ||
| # set to NO, the Qt-style will behave just like regular Qt-style comments (thus | ||
| # requiring an explicit \brief command for a brief description.) | ||
| # The default value is: NO. | ||
|
|
||
| QT_AUTOBRIEF = NO | ||
| QT_AUTOBRIEF = YES |
There was a problem hiding this comment.
Why do we need both QT_AUTOBRIEF and JAVADOC_AUTOBRIEF? I suggest to stick with one style of doxygen comments and therefore, don't encourage usage of others by disabling different helper features for them
There was a problem hiding this comment.
@AlexeySachkov is it ok if I prepare a separate pull request that makes the whole documentation up to LLVM standards and disables all Java-style features for good?
There was a problem hiding this comment.
@alexbatashev, works for me
There was a problem hiding this comment.
@AlexeySachkov, please, "resolve" conversations to let me know that PRs are ready for merge.
AlexeySachkov
approved these changes
Feb 27, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Alexander Batashev alexander.batashev@intel.com