This repository has been archived by the owner on Mar 26, 2020. It is now read-only.
Follow naming convention for parameter names in method docstrings #352
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
Because parameter names may not be written in the same format between C++, Objective-C, and Java, it is impossible to have doxygen- or javadoc-style @param annotations that match for all languages. This change simply looks for "@param <PARAMNAME>" in the docstring and rewrites it the same way as the sourcecode does.
|
Thanks for taking a stab at this. Sounds good in abstract. I haven't looked at the code in detail. You should add some cases which trigger the new behavior in the test suite and/or example app, then re-run the generators so that we can see the generated output changes in this diff. |
|
Will do |
And reference it from the docstring.
This reverts commit 785a226.
And reference it from the docstring.
KhalilBellakrid
pushed a commit
to KhalilBellakrid/djinni
that referenced
this pull request
Mar 8, 2018
…opbox#352) * Update parameter names in documentation Because parameter names may not be written in the same format between C++, Objective-C, and Java, it is impossible to have doxygen- or javadoc-style @param annotations that match for all languages. This change simply looks for "@param <PARAMNAME>" in the docstring and rewrites it the same way as the sourcecode does. * Replace all occurrences of parameter name in docstring * Also update Java for static methods * Add multi-word parameter name to test suite And reference it from the docstring. * Revert "Add multi-word parameter name to test suite" This reverts commit 785a226. * Add multi-word parameter name to test suite And reference it from the docstring.
danielkaldheim
pushed a commit
to danielkaldheim/djinni
that referenced
this pull request
Mar 27, 2018
…opbox#352) * Update parameter names in documentation Because parameter names may not be written in the same format between C++, Objective-C, and Java, it is impossible to have doxygen- or javadoc-style @param annotations that match for all languages. This change simply looks for "@param <PARAMNAME>" in the docstring and rewrites it the same way as the sourcecode does. * Replace all occurrences of parameter name in docstring * Also update Java for static methods * Add multi-word parameter name to test suite And reference it from the docstring. * Revert "Add multi-word parameter name to test suite" This reverts commit 785a226. * Add multi-word parameter name to test suite And reference it from the docstring.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The problem here is that if I have differing naming conventions in different languages then if I mention a method parameter name in my djinni docstring it will be wrong in at least one language (e.g.
some_parameterin C++ butsomeParameterin Obj-C and Java). And I will probably mention them if I'm using doxygen or javadoc (@param some_parameter). Beyond being annoying, this causes warnings in XCode and probably other environments.The fix will run every method docstring through a series of regexes that replace each djinni parameter name with the corresponding name in the language naming convention.
Drawbacks
This is a fix for #332, which I opened.