hbase-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Lars Francke (JIRA)" <j...@apache.org>
Subject [jira] Updated: (HBASE-2153) Publish generated HTML documentation for Thrift on the website
Date Fri, 22 Jan 2010 02:38:54 GMT

     [ https://issues.apache.org/jira/browse/HBASE-2153?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Lars Francke updated HBASE-2153:
--------------------------------

    Attachment: HBase-2153.patch

That was easier then I expected. I didn't know about the this feature of Javadoc. This patch
conflicts with the one on HBASE-1373 as both change the package documentation but I'll gladly
update one patch once the other has been applied. It is an easy fix either way.

This patch adds three generated files to the doc-files directory in the thrift package. Those
are generated by the Thrift HTML generator. This also changes Hbase.thrift to add additional
whitespace to generate properly formatted HTML.

> Publish generated HTML documentation for Thrift on the website
> --------------------------------------------------------------
>
>                 Key: HBASE-2153
>                 URL: https://issues.apache.org/jira/browse/HBASE-2153
>             Project: Hadoop HBase
>          Issue Type: Improvement
>          Components: thrift
>            Reporter: Lars Francke
>            Assignee: Lars Francke
>            Priority: Minor
>         Attachments: HBase-2153.patch
>
>
> Thrift has a compiler that generates pretty HTML documentation for a .thrift file. An
example can be seen on the Evernote page (http://www.evernote.com/about/developer/api/ref/).
I think it'd be valuable to offer the same for HBase and publish it on the website alongside
the normal documentation. I've never worked with Forrest before but I'll have a look if I
can find the correct place to insert this.
> There is one ticket on Thrift that I'd like to see resolved first (THRIFT-681).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message