You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hbase.apache.org by "stack (JIRA)" <ji...@apache.org> on 2010/01/21 03:24:54 UTC
[jira] Created: (HBASE-2151) Remove onelab and include generated
thrift classes in javadoc
Remove onelab and include generated thrift classes in javadoc
-------------------------------------------------------------
Key: HBASE-2151
URL: https://issues.apache.org/jira/browse/HBASE-2151
Project: Hadoop HBase
Issue Type: Bug
Reporter: stack
Assignee: Lars Francke
Priority: Minor
Fix For: 0.21.0
Patch is actually over in hbase-1373 named javadoc.patch. It was done by Lars Francke so I assigned him this issue.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2151) Remove onelab and include generated
thrift classes in javadoc
Posted by "stack (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2151?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12803135#action_12803135 ]
stack commented on HBASE-2151:
------------------------------
Here is a sample:
{code}
[javadoc] Building tree for all the packages and classes...
[javadoc] /Users/stack/checkouts/hbase/trunk.old/src/java/org/apache/hadoop/hbase/thrift/generated/Hbase.java:49: warning - Parameter "tableName" is documented more than once.
[javadoc] /Users/stack/checkouts/hbase/trunk.old/src/java/org/apache/hadoop/hbase/thrift/generated/Hbase.java:58: warning - Parameter "tableName" is documented more than once.
[javadoc] /Users/stack/checkouts/hbase/trunk.old/src/java/org/apache/hadoop/hbase/thrift/generated/Hbase.java:66: warning - Parameter "tableName" is documented more than once.
[javadoc] /Users/stack/checkouts/hbase/trunk.old/src/java/org/apache/hadoop/hbase/thrift/generated/Hbase.java:85: warning - Parameter "tableName" is documented more than once.
[javadoc] /Users/stack/checkouts/hbase/trunk.old/src/java/org/apache/hadoop/hbase/thrift/generated/Hbase.java:94: warning - Parameter "tableName" is documented more than once.
[javadoc] /Users/stack/checkouts/hbase/trunk.old/src/java/org/apache/hadoop/hbase/thrift/generated/Hbase.java:111: warning - Parameter "tableName" is documented more than once.
[javadoc] /Users/stack/checkouts/hbase/trunk.old/src/java/org/apache/hadoop/hbase/thrift/generated/Hbase.java:111: warning - Parameter "columnFamilies" is documented more than once.
[javadoc] /Users/stack/checkouts/hbase/trunk.old/src/java/org/apache/hadoop/hbase/thrift/generated/Hbase.java:121: warning - Parameter "tableName" is documented more than once.
[javadoc] /Users/stack/checkouts/hbase/trunk.old/src/java/org/apache/hadoop/hbase/thrift/generated/Hbase.java:136: warning - Parameter "tableName" is documented more than once.
[javadoc] /Users/stack/checkouts/hbase/trunk.old/src/java/org/apache/hadoop/hbase/thrift/generated/Hbase.java:136: warning - Parameter "row" is documented more than once.
[javadoc] /Users/stack/checkouts/hbase/trunk.old/src/java/org/apache/hadoop/hbase/thrift/generated/Hbase.java:136: warning - Parameter "column" is documented more than once.
..
{code}
> Remove onelab and include generated thrift classes in javadoc
> -------------------------------------------------------------
>
> Key: HBASE-2151
> URL: https://issues.apache.org/jira/browse/HBASE-2151
> Project: Hadoop HBase
> Issue Type: Bug
> Reporter: stack
> Assignee: Lars Francke
> Priority: Minor
> Fix For: 0.21.0
>
>
> Patch is actually over in hbase-1373 named javadoc.patch. It was done by Lars Francke so I assigned him this issue.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2151) Remove onelab and include generated
thrift classes in javadoc
Posted by "Lars Francke (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2151?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12803149#action_12803149 ]
Lars Francke commented on HBASE-2151:
-------------------------------------
I've missed this, thanks. IDEA hid those warnings well. I learn something new about Thrift every day. I have a fix and I'll probably attach it tomorrow (seeing as I'm in CET time here ;-) ).
It requires changes to Hbase.thrift and thus to the generated classes but nothing serious.
Just for reference how a function in Thrift needs to be documented.
{noformat}
/**
* Disables a table (takes it off-line) If it is being served, the master
* will tell the servers to stop serving it.
*/
void disableTable(
/** name of the table */
1:Bytes tableName
) throws (1:IOError io)
{noformat}
This is how it is in the current version of Hbase.thrift
{noformat}
/**
* Disables a table (takes it off-line) If it is being served, the master
* will tell the servers to stop serving it.
* @param tableName name of the table
*/
void disableTable(1:Bytes tableName) throws (1:IOError io)
{noformat}
This makes the Hbase.thrift file a little bit more ugly but at least the documentation is correct.
> Remove onelab and include generated thrift classes in javadoc
> -------------------------------------------------------------
>
> Key: HBASE-2151
> URL: https://issues.apache.org/jira/browse/HBASE-2151
> Project: Hadoop HBase
> Issue Type: Bug
> Reporter: stack
> Assignee: Lars Francke
> Priority: Minor
> Fix For: 0.21.0
>
>
> Patch is actually over in hbase-1373 named javadoc.patch. It was done by Lars Francke so I assigned him this issue.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-2151) Remove onelab and include generated
thrift classes in javadoc
Posted by "stack (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2151?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12803133#action_12803133 ]
stack commented on HBASE-2151:
------------------------------
Hmm. There's a bunch of javadoc warnings if I include thrift generated files. Can these be fixed Lars?
> Remove onelab and include generated thrift classes in javadoc
> -------------------------------------------------------------
>
> Key: HBASE-2151
> URL: https://issues.apache.org/jira/browse/HBASE-2151
> Project: Hadoop HBase
> Issue Type: Bug
> Reporter: stack
> Assignee: Lars Francke
> Priority: Minor
> Fix For: 0.21.0
>
>
> Patch is actually over in hbase-1373 named javadoc.patch. It was done by Lars Francke so I assigned him this issue.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HBASE-2151) Remove onelab and include generated
thrift classes in javadoc
Posted by "Lars Francke (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2151?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Lars Francke updated HBASE-2151:
--------------------------------
Attachment: HBase-2151.patch
This (in addition to the javadoc patch from HBASE-1373) fixes all Javadoc issues for me.
There are only documentation changes for the Hbase.thrift file but I had to regenerate Hbase.java for those changes to take effect.
> Remove onelab and include generated thrift classes in javadoc
> -------------------------------------------------------------
>
> Key: HBASE-2151
> URL: https://issues.apache.org/jira/browse/HBASE-2151
> Project: Hadoop HBase
> Issue Type: Bug
> Reporter: stack
> Assignee: Lars Francke
> Priority: Minor
> Fix For: 0.21.0
>
> Attachments: HBase-2151.patch
>
>
> Patch is actually over in hbase-1373 named javadoc.patch. It was done by Lars Francke so I assigned him this issue.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Resolved: (HBASE-2151) Remove onelab and include generated
thrift classes in javadoc
Posted by "stack (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-2151?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
stack resolved HBASE-2151.
--------------------------
Resolution: Fixed
Hadoop Flags: [Reviewed]
Worked for me. I can see the generated classes showing in javadoc now. Thanks for the patch Lars Francke.
> Remove onelab and include generated thrift classes in javadoc
> -------------------------------------------------------------
>
> Key: HBASE-2151
> URL: https://issues.apache.org/jira/browse/HBASE-2151
> Project: Hadoop HBase
> Issue Type: Bug
> Reporter: stack
> Assignee: Lars Francke
> Priority: Minor
> Fix For: 0.21.0
>
> Attachments: HBase-2151.patch
>
>
> Patch is actually over in hbase-1373 named javadoc.patch. It was done by Lars Francke so I assigned him this issue.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.