-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enhanced Documentation? #640
Comments
Then running jsdoc against the staticModule would product more complete and better documentation than what the plugin tool is producing. |
I really like the idea. Currently, the tokenizer skips over comments, though. Will have a look whether it's possible or not. |
…uses them when generating static code, see #640
There is probably more to do here. For reference, this is the test case:
|
…s because old protos may generate a lot of nonsense otherwise, see #640
While looking at the output of other test files, I realized that parsing all types of comments leads to a lot of nonsense for older protos, like using just commented out lines as field descriptions and stuff like that. Therefore, I decided to limit comment parsing to actual For example, this should do what you want: /**
* The type of change the published type represents
*/
enum ChangeType {
/** An Unknown ChangeType condition */
CHG_UNKNOWN = 0;
/** Updated or Insert / Added */
CHG_UPSERT = 1;
/** Deleted */
CHG_DELETED = 2;
} Might still look at |
And now also this: /**
* The type of change the published type represents
*/
enum ChangeType {
CHG_UNKNOWN = 0; /// An Unknown ChangeType condition
CHG_UPSERT = 1; /// Updated or Insert / Added
CHG_DELETED = 2; /// Deleted
} |
That looks pretty damn good sir. Double Thanks |
protobuf.js version: <6.4.2>
Enhancement Request.
Was checking out https://github.com/estan/protoc-gen-doc and looking at the results, and thought that maybe pbjs could add the comments from a .proto file to it's own generated comments
Cheers
The text was updated successfully, but these errors were encountered: