[
https://issues.apache.org/jira/browse/THRIFT-173?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12640280#action_12640280
]
Michael Greene commented on THRIFT-173:
---------------------------------------
This looks like a great feature. Some nitpicks:
{code}
f_out_ << "<h4 id=\"Fn_" << service_name_ << "_" << fn_name
<< "\">Function: " << service_name_ << "." << fn_name
<< "</h3>" << endl;
{code}
Service names should be opened and closed with the same tag (H4).
There's a reference to Objective C in the comments of
{{t_html_generator::generate_service}} that I'm assuming is a copy/paste
carry-over.
There's a confusing mix of HTML and XHTML in the output, with no declaration of
which is being used. LINK, DT, and DD are unclosed (HTML) but BR, P, and HR
are self-closing tags (XHTML).
{{int t_html_generator::print_type(t_type* ttype)}} should be consistent with
its use of entities. Currently it opens with {{lt}} entities but closes with
{{>}} angle-brackets.
> Thrift -> HTML generator patch
> ------------------------------
>
> Key: THRIFT-173
> URL: https://issues.apache.org/jira/browse/THRIFT-173
> Project: Thrift
> Issue Type: New Feature
> Reporter: Dave Engberg
> Priority: Minor
> Attachments: t_html_generator.patch
>
>
> We've found that new developers have a hard time navigating generated Thrift
> APIs since most generators ignore inline documentation in the Thrift files.
> I put together a basic .thrift -> .html generator that will produce an
> interlinked set of HTML reference files, including any inline documentation
> for services, functions, structs, exceptions, typedefs, enums, and constants.
> Here's a sample output from our Thrift API:
> http://www.evernote.com/about/developer/api/ref/
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
