Bug 749368

Summary: add @since Javadoc tags to our public APIs (agent plugin API and server remote API)
Product: [JBoss] JBoss Operations Network Reporter: Ian Springer <ian.springer>
Component: CLI, Plugin -- OtherAssignee: RHQ Project Maintainer <rhq-maint>
Status: CLOSED CURRENTRELEASE QA Contact: Mike Foley <mfoley>
Severity: medium Docs Contact:
Priority: unspecified    
Version: JON 3.0.0CC: ccrouch, hrupp, jshaughn, loleary, myarboro
Target Milestone: DR01Keywords: FutureFeature
Target Release: JON 3.3.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Enhancement
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2014-12-11 14:04:29 UTC Type: Task
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Attachments:
Description Flags
adds @since tags to all plugin API classes, except those under content and util packages none

Description Ian Springer 2011-10-26 20:03:05 UTC 
Similarly to the Java SE API docs, @since tags only need to be added to classes or methods that were added post RHQ 1.0 (i.e. no @since tag would imply the class or method has existed since RHQ 1.0). This will make our HTML API docs more useful, since users will be able to see when various methods got added to the API.
Comment 1 Ian Springer 2011-10-26 20:06:39 UTC 
Created attachment 530375 [details]
adds @since tags to all plugin API classes, except those under content and util packages
Comment 2 Ian Springer 2012-02-26 22:30:15 UTC 
The attached patch has been applied and committed to master:

http://git.fedorahosted.org/git/?p=rhq/rhq.git;a=commitdiff;h=ee49856

However, I think a few classes still need @since tags. I will review them before closing this BZ.
Comment 5 Jay Shaughnessy 2014-07-22 20:21:37 UTC 

commit 181e5e7844c6bbe9972d863eb734190631c53fba
Author: Jay Shaughnessy <jshaughn>
Date:   Tue Jul 22 16:18:57 2014 -0400

    [749368] add @since Javadoc tags to our public APIs
    Went through our intentional-changes files and added  agfew missing @since
    tags that seemed maybe useful.  I had previously updated the server's
    SLSB remote API, just added 4.12 for that.
Comment 6 Simeon Pinder 2014-07-31 15:51:59 UTC 
Moving to ON_QA as available to test with brew build of DR01: https://brewweb.devel.redhat.com//buildinfo?buildID=373993