Add doc support of lambda parameters and return value for cpp,swift,dart #1545
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
limingchina
force-pushed
the
add_doc_support_for_lambda_param_and_return_value
branch
from
849865c
to
5b3815e
Compare
limingchina
changed the title
…pp,swift,dart. The android generator(java) already works see: heremaps#1544 Signed-off-by: Ming Li <[email protected]>
limingchina
force-pushed
the
add_doc_support_for_lambda_param_and_return_value
branch
2 times, most recently
from
3d6217e
to
ecabe32
Compare
Also removed the added functional test case since smoke test already covers it.
limingchina
force-pushed
the
add_doc_support_for_lambda_param_and_return_value
branch
from
ecabe32
to
349cdee
Compare
limingchina
commented
Aug 4, 2023
| @@ -84,6 +85,7 @@ internal class CppNameResolver( | |||
| is LimeType -> resolveTypeName(element, isFullName = false) | |||
| is LimeTypeRef -> resolveTypeRef(element) | |||
| is LimeReturnType -> resolveTypeRef(element.typeRef) | |||
| is LimeLambdaParameter -> resolveTypeRef(element.typeRef) | |||
There was a problem hiding this comment.
Without this addition, it would go to the throw statement.
limingchina
commented
Aug 4, 2023
| @@ -18,7 +18,9 @@ | |||
| ! License-Filename: LICENSE | |||
| ! | |||
| !}} | |||
| {{>dart/DartDocumentation}}{{>dart/DartAttributes}} | |||
| {{>dart/DartLambdaDocs}} | |||
|
|
|||
There was a problem hiding this comment.
I have to leave a blank line here. Otherwise, the lambda declaration will be in the same line as the empty comment, which would hide the lambda declaration.
limingchina
commented
Aug 4, 2023
| @@ -18,23 +18,8 @@ | |||
| ! License-Filename: LICENSE | |||
| ! | |||
| !}} | |||
| {{#resolveName comment}}{{#unless this.isEmpty}}{{prefix this "/// "}} | |||
There was a problem hiding this comment.
I have to split this the doc part and attribute part. Otherwise, the lambda gets some duplicated attributes here
…tache Signed-off-by: Ming Li <[email protected]>
limingchina
force-pushed
the
add_doc_support_for_lambda_param_and_return_value
branch
from
46a3055
to
64d7aac
Compare
limingchina
commented
Aug 7, 2023
| * \private | ||
| * \param[in] ::std::string |
There was a problem hiding this comment.
This one lost the const&. Would need some fix.
|
#1546 has a more complete fix. Close this PR. |
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.
see: #1544
Currently, the documentation of parameters and return values for lambdas only works for java. All the other generators don't work. This is because that Java's lambda declaration is called functional interface and is similar like a function declaration. However, for the other generators, the mustache template file only uses normal documentation instead of function documentation.
For the return type, the issue is that the LimeParser doesn't have doc support for the return type of a lambda.
This change addresses the two issues.
The fix still has some limitation, though. In java, one can use specify a name for the lambda parameter and use that in the parameter documentation. With the current change, only the types will appear in the lambda declaration and docs. To limit the scope of this change. This is left for future improvement.