docs: fix wrong link #4
Closed
Conversation
This file contains 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
|
Hi, thank you for submitting this pull request. In order to consider your code we need you to sign the Oracle Contribution Agreement (OCA). Please review the details and follow the instructions at http://www.oracle.com/technetwork/community/oca-486395.html |
nawazn
pushed a commit
that referenced
this pull request
Jul 22, 2019
This push introduces the following enhancements to the help system: 1) Adds member naming style resolution even for Doxygen generated help. 2) Adds support for <br> in shell help. 3) Replaces <code></code> for @code @Endcode Collateral change: detected that <code> was being used in a wrong way to create a hardcoded formatting on the Command Line integration help. Have reformatted that help to use standard formating. Naming Style Resolution in Doxygen ---------------------------------- Resolution of member names has been supported in the shell help by simply enclosing the member name as <<<camelCaseMemberName>>>. However this did not work for Doxygen and we ended adding chunks of help defined between DOXYGEN_JS/DOXYGEN_PY whenever we wanted to refer to another member on the help. Now this resolution also works for Doxygen as long as it is defined in any of the REGISTER_*HELP* macros, this is, does not work if using <<<>>> directly in doxygen comments. Support for <br> ---------------- This is simply handy, it will be rendered as a new line character on the shell help. New Code Commands ----------------- It was detected that <code></code> were not achieving the desired effect in the Doxygen docs (which is creating a code snippet). For this reason we have replaced it in the shell to use @code and @Endcode commands instead. Suggestion that whenever @code is required, the help is registered using the new REGISTER_*HELP* macros that allow defining the entire help in a multiline text definition, reason for this is because whatever spacing you use, it will be rendered that way with no extra effort. If not done that way you will have to give the desired formatting to the text, i.e. adding new lines, using  , etc. For examples about #1 look at the changes in mod_shell.cc For examples about #3 the good way, look at the changes in mod_mysqlx_collection.cc For examples about #4 the bad way, look at the changes in mod_util.cc Change-Id: I50e0812d86efa528abde8c690d96157c103ac66d
|
@orisano Thanks for pointing this out. |
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.
No description provided.