THRIFT-4305 Doc comments in dlang output #1396
Closed
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
Thrift IDL supports documentation comments. D supports doc comments. So let's copy them over! Future directions: add function parameter docs. ddoc expects them in a particular format.
Contributor
|
Manually inspecting the result in a sandbox. |
jeking3
approved these changes
Oct 23, 2017
Contributor
jeking3
left a comment
jeking3
left a comment
There was a problem hiding this comment.
Manually inspected results:
diff --git a/tmp/gen-d/without/DebugProtoTest_constants.d b/tmp/gen-d/with/DebugProtoTest_constants.d
index 6929a68a..fda94f1e 100644
--- a/tmp/gen-d/without/DebugProtoTest_constants.d
+++ b/tmp/gen-d/with/DebugProtoTest_constants.d
@@ -14,6 +14,9 @@ import DebugProtoTest_types;
immutable(CompactProtoTestStruct) COMPACT_TEST;
immutable(int) MYCONST;
+/**
+ This is a docstring on a constant!
+*/
immutable(SomeEnum) MY_SOME_ENUM;
immutable(SomeEnum) MY_SOME_ENUM_1;
immutable(SomeEnum[SomeEnum]) MY_ENUM_MAP;
jeking3
pushed a commit
to jeking3/thrift
that referenced
this pull request
Nov 30, 2017
Client: d Patch: Neia Neutuladh This closes apache#1396 This closes apache#1395
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Thrift IDL supports documentation comments. D supports doc comments.
So let's copy them over!
Future directions: add function parameter docs. ddoc expects them in
a particular format.