You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@atlas.apache.org by Richard Ding via Review Board <no...@reviews.apache.org> on 2017/08/10 18:15:39 UTC

Review Request 61568: ATLAS-2003: Add Javadoc format to class summaries

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/61568/
-----------------------------------------------------------

Review request for atlas, David Radley, Madhan Neethiraj, and Sarath Subramanian.


Bugs: ATLAS-2003
    https://issues.apache.org/jira/browse/ATLAS-2003


Repository: atlas


Description
-------

This patch added Javadoc format to the following class summaries: 
```
InMemoryJAASConfiguration.java 
TitanGraphQuery.java       
AtlasRelationshipDef.java  
NotificationInterface.java 
ExpandAndsOptimization.java 
HBaseBasedAuditRepository.java           
```


Diffs
-----

  common/src/main/java/org/apache/atlas/security/InMemoryJAASConfiguration.java c65048fa 
  graphdb/common/src/main/java/org/apache/atlas/repository/graphdb/titan/query/TitanGraphQuery.java c38f6cc8 
  intg/src/main/java/org/apache/atlas/model/typedef/AtlasRelationshipDef.java c17e875d 
  notification/src/main/java/org/apache/atlas/notification/NotificationInterface.java ef8ee275 
  repository/src/main/java/org/apache/atlas/gremlin/optimizer/ExpandAndsOptimization.java 7cf97110 
  repository/src/main/java/org/apache/atlas/repository/audit/HBaseBasedAuditRepository.java 06e518ee 


Diff: https://reviews.apache.org/r/61568/diff/1/


Testing
-------

Verified with Javadoc build.


Thanks,

Richard Ding


Re: Review Request 61568: ATLAS-2003: Add Javadoc format to class summaries

Posted by Richard Ding via Review Board <no...@reviews.apache.org>.

> On Aug. 11, 2017, 9:22 a.m., David Radley wrote:
> > common/src/main/java/org/apache/atlas/security/InMemoryJAASConfiguration.java
> > Lines 54 (patched)
> > <https://reviews.apache.org/r/61568/diff/1/?file=1795060#file1795060line54>
> >
> >     Hi Richard, this looks good - please could you generate the swagger and make sure that it tolerates the markup you have added.

The following mvn command runs successfully after applying the patch: 
>mvn -DskipTests -DskipEnunciate=false clean package 

The swagger docs are generated in the directory:
>webapp/target/api/v2/apidocs


- Richard


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/61568/#review182672
-----------------------------------------------------------


On Aug. 10, 2017, 6:15 p.m., Richard Ding wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/61568/
> -----------------------------------------------------------
> 
> (Updated Aug. 10, 2017, 6:15 p.m.)
> 
> 
> Review request for atlas, David Radley, Madhan Neethiraj, and Sarath Subramanian.
> 
> 
> Bugs: ATLAS-2003
>     https://issues.apache.org/jira/browse/ATLAS-2003
> 
> 
> Repository: atlas
> 
> 
> Description
> -------
> 
> This patch added Javadoc format to the following class summaries: 
> ```
> InMemoryJAASConfiguration.java 
> TitanGraphQuery.java       
> AtlasRelationshipDef.java  
> NotificationInterface.java 
> ExpandAndsOptimization.java 
> HBaseBasedAuditRepository.java           
> ```
> 
> 
> Diffs
> -----
> 
>   common/src/main/java/org/apache/atlas/security/InMemoryJAASConfiguration.java c65048fa 
>   graphdb/common/src/main/java/org/apache/atlas/repository/graphdb/titan/query/TitanGraphQuery.java c38f6cc8 
>   intg/src/main/java/org/apache/atlas/model/typedef/AtlasRelationshipDef.java c17e875d 
>   notification/src/main/java/org/apache/atlas/notification/NotificationInterface.java ef8ee275 
>   repository/src/main/java/org/apache/atlas/gremlin/optimizer/ExpandAndsOptimization.java 7cf97110 
>   repository/src/main/java/org/apache/atlas/repository/audit/HBaseBasedAuditRepository.java 06e518ee 
> 
> 
> Diff: https://reviews.apache.org/r/61568/diff/1/
> 
> 
> Testing
> -------
> 
> Verified with Javadoc build.
> 
> 
> Thanks,
> 
> Richard Ding
> 
>


Re: Review Request 61568: ATLAS-2003: Add Javadoc format to class summaries

Posted by David Radley <da...@apache.org>.

> On Aug. 11, 2017, 9:22 a.m., David Radley wrote:
> > common/src/main/java/org/apache/atlas/security/InMemoryJAASConfiguration.java
> > Lines 54 (patched)
> > <https://reviews.apache.org/r/61568/diff/1/?file=1795060#file1795060line54>
> >
> >     Hi Richard, this looks good - please could you generate the swagger and make sure that it tolerates the markup you have added.
> 
> Richard Ding wrote:
>     The following mvn command runs successfully after applying the patch: 
>     >mvn -DskipTests -DskipEnunciate=false clean package 
>     
>     The swagger docs are generated in the directory:
>     >webapp/target/api/v2/apidocs

Hi Richard - I built it and it looks good. I will commit it once the build break has been fixed, all the best, David.


- David


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/61568/#review182672
-----------------------------------------------------------


On Aug. 10, 2017, 6:15 p.m., Richard Ding wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/61568/
> -----------------------------------------------------------
> 
> (Updated Aug. 10, 2017, 6:15 p.m.)
> 
> 
> Review request for atlas, David Radley, Madhan Neethiraj, and Sarath Subramanian.
> 
> 
> Bugs: ATLAS-2003
>     https://issues.apache.org/jira/browse/ATLAS-2003
> 
> 
> Repository: atlas
> 
> 
> Description
> -------
> 
> This patch added Javadoc format to the following class summaries: 
> ```
> InMemoryJAASConfiguration.java 
> TitanGraphQuery.java       
> AtlasRelationshipDef.java  
> NotificationInterface.java 
> ExpandAndsOptimization.java 
> HBaseBasedAuditRepository.java           
> ```
> 
> 
> Diffs
> -----
> 
>   common/src/main/java/org/apache/atlas/security/InMemoryJAASConfiguration.java c65048fa 
>   graphdb/common/src/main/java/org/apache/atlas/repository/graphdb/titan/query/TitanGraphQuery.java c38f6cc8 
>   intg/src/main/java/org/apache/atlas/model/typedef/AtlasRelationshipDef.java c17e875d 
>   notification/src/main/java/org/apache/atlas/notification/NotificationInterface.java ef8ee275 
>   repository/src/main/java/org/apache/atlas/gremlin/optimizer/ExpandAndsOptimization.java 7cf97110 
>   repository/src/main/java/org/apache/atlas/repository/audit/HBaseBasedAuditRepository.java 06e518ee 
> 
> 
> Diff: https://reviews.apache.org/r/61568/diff/1/
> 
> 
> Testing
> -------
> 
> Verified with Javadoc build.
> 
> 
> Thanks,
> 
> Richard Ding
> 
>


Re: Review Request 61568: ATLAS-2003: Add Javadoc format to class summaries

Posted by David Radley <da...@apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/61568/#review182672
-----------------------------------------------------------




common/src/main/java/org/apache/atlas/security/InMemoryJAASConfiguration.java
Lines 54 (patched)
<https://reviews.apache.org/r/61568/#comment258660>

    Hi Richard, this looks good - please could you generate the swagger and make sure that it tolerates the markup you have added.


- David Radley


On Aug. 10, 2017, 6:15 p.m., Richard Ding wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/61568/
> -----------------------------------------------------------
> 
> (Updated Aug. 10, 2017, 6:15 p.m.)
> 
> 
> Review request for atlas, David Radley, Madhan Neethiraj, and Sarath Subramanian.
> 
> 
> Bugs: ATLAS-2003
>     https://issues.apache.org/jira/browse/ATLAS-2003
> 
> 
> Repository: atlas
> 
> 
> Description
> -------
> 
> This patch added Javadoc format to the following class summaries: 
> ```
> InMemoryJAASConfiguration.java 
> TitanGraphQuery.java       
> AtlasRelationshipDef.java  
> NotificationInterface.java 
> ExpandAndsOptimization.java 
> HBaseBasedAuditRepository.java           
> ```
> 
> 
> Diffs
> -----
> 
>   common/src/main/java/org/apache/atlas/security/InMemoryJAASConfiguration.java c65048fa 
>   graphdb/common/src/main/java/org/apache/atlas/repository/graphdb/titan/query/TitanGraphQuery.java c38f6cc8 
>   intg/src/main/java/org/apache/atlas/model/typedef/AtlasRelationshipDef.java c17e875d 
>   notification/src/main/java/org/apache/atlas/notification/NotificationInterface.java ef8ee275 
>   repository/src/main/java/org/apache/atlas/gremlin/optimizer/ExpandAndsOptimization.java 7cf97110 
>   repository/src/main/java/org/apache/atlas/repository/audit/HBaseBasedAuditRepository.java 06e518ee 
> 
> 
> Diff: https://reviews.apache.org/r/61568/diff/1/
> 
> 
> Testing
> -------
> 
> Verified with Javadoc build.
> 
> 
> Thanks,
> 
> Richard Ding
> 
>


Re: Review Request 61568: ATLAS-2003: Add Javadoc format to class summaries

Posted by David Radley <da...@apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/61568/#review182940
-----------------------------------------------------------


Ship it!




Ship It!

- David Radley


On Aug. 10, 2017, 6:15 p.m., Richard Ding wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/61568/
> -----------------------------------------------------------
> 
> (Updated Aug. 10, 2017, 6:15 p.m.)
> 
> 
> Review request for atlas, David Radley, Madhan Neethiraj, and Sarath Subramanian.
> 
> 
> Bugs: ATLAS-2003
>     https://issues.apache.org/jira/browse/ATLAS-2003
> 
> 
> Repository: atlas
> 
> 
> Description
> -------
> 
> This patch added Javadoc format to the following class summaries: 
> ```
> InMemoryJAASConfiguration.java 
> TitanGraphQuery.java       
> AtlasRelationshipDef.java  
> NotificationInterface.java 
> ExpandAndsOptimization.java 
> HBaseBasedAuditRepository.java           
> ```
> 
> 
> Diffs
> -----
> 
>   common/src/main/java/org/apache/atlas/security/InMemoryJAASConfiguration.java c65048fa 
>   graphdb/common/src/main/java/org/apache/atlas/repository/graphdb/titan/query/TitanGraphQuery.java c38f6cc8 
>   intg/src/main/java/org/apache/atlas/model/typedef/AtlasRelationshipDef.java c17e875d 
>   notification/src/main/java/org/apache/atlas/notification/NotificationInterface.java ef8ee275 
>   repository/src/main/java/org/apache/atlas/gremlin/optimizer/ExpandAndsOptimization.java 7cf97110 
>   repository/src/main/java/org/apache/atlas/repository/audit/HBaseBasedAuditRepository.java 06e518ee 
> 
> 
> Diff: https://reviews.apache.org/r/61568/diff/1/
> 
> 
> Testing
> -------
> 
> Verified with Javadoc build.
> 
> 
> Thanks,
> 
> Richard Ding
> 
>