You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@thrift.apache.org by "Craig Peterson (JIRA)" <ji...@apache.org> on 2014/01/15 22:09:19 UTC

[jira] [Commented] (THRIFT-2320) Program level doctext does not get attatched by parser

    [ https://issues.apache.org/jira/browse/THRIFT-2320?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13872591#comment-13872591 ] 

Craig Peterson commented on THRIFT-2320:
----------------------------------------

This is my first patch. Not sure if I did it quite right. I implemented it by adding another set of globals to track the very first doctext token read by the lexer. Feels like a bit of a hack, but less so than some other options. Should gracefully avoid setting program doctext to the first element's doctext when a program level doc does not exist.

> Program level doctext does not get attatched by parser
> ------------------------------------------------------
>
>                 Key: THRIFT-2320
>                 URL: https://issues.apache.org/jira/browse/THRIFT-2320
>             Project: Thrift
>          Issue Type: Improvement
>          Components: Compiler (General)
>    Affects Versions: 0.9.1
>            Reporter: Craig Peterson
>         Attachments: program_doctext.patch
>
>
> I am using the html generator to generate documentation for our api. It would be really useful to define a block of text that outlines our service in general and how to use it. It looks like the data model has the capability to communicate a program level doc, and the html generator tries to use it, but it never gets stored onto the program object from the parser.



--
This message was sent by Atlassian JIRA
(v6.1.5#6160)