[
https://issues.apache.org/jira/browse/THRIFT-173?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Dave Engberg updated THRIFT-173:
--------------------------------
Attachment: t_html_generator.patch
Replacement patch that fixes four errors caught by Michael Greene:
Service function header is now properly closed with </h4> instead of </h3>
Removed bad copy-paste reference to Objective-C in a comment
Emit ">" instead of ">"
Unclosed "<LINK...>"
Michael also pointed out that the HTML in Evernote's generated API docs
contains inconsistent tagging (unclosed DL, DD):
http://www.evernote.com/about/developer/api/ref/
These inconsistencies come from HTML markup within our own .thrift IDL
comments. (We're using Javadoc conventions in a few places since Java is our
primary service language.) The generator produces XHTML style tags, but it does
not sanitize any raw HTML markup found within the inline .thrift docs. As a
result of this, it might not be safe to declare any strict DTD for the
generated code, since this would assume that the inline markup was correct.
> 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.
