[jira] [Comment Edited] (IGNITE-5018) review and improve javadocs in ML module

["Anton Vinogradov (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/IGNITE-5018?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15975098#comment-15975098 ] 

Anton Vinogradov edited comment on IGNITE-5018 at 4/19/17 5:09 PM:
-------------------------------------------------------------------

After merge I found that ML module does not match project requirements:
https://cwiki.apache.org/confluence/display/IGNITE/Coding+Guidelines

I've found at least 26 files with wrong code style using automatical formatting using IDEA's codestyle from idea/ignite_codeStyle.xml

most of found related to javadoc
Provided:
{noformat}
    /** */ private IgniteFunction<Integer, Double> getFunc;
    /** */ private IntDoubleToVoidFunction setFunc;
    /** */ private int size;

{noformat}

Correct:
{noformat}
    /** */
    private IgniteFunction<Integer, Double> getFunc;

    /** */
    private IntDoubleToVoidFunction setFunc;

    /** */
    private int size;
{noformat}

Formatting and abbreviations should be checked prior to any merge request.
Hope this will be checked and fixed before next merge and/or on each commiters request.





was (Author: avinogradov):
After merge I found that ML module does not match project requirements:
https://cwiki.apache.org/confluence/display/IGNITE/Coding+Guidelines

I've found at least 26 files with wrong code style using automatical formatting using IDEA's codestyle from idea/ignite_codeStyle.xml

most of found related to javadoc
Provided:
{noformat}
    /** */ private IgniteFunction<Integer, Double> getFunc;
    /** */ private IntDoubleToVoidFunction setFunc;
    /** */ private int size;

{noformat}

Correct:
{noformat}
    /** */
    private IgniteFunction<Integer, Double> getFunc;
    /** */
    private IntDoubleToVoidFunction setFunc;
    /** */
    private int size;
{noformat}

Formatting and abbreviations should be checked prior to any merge request.
Hope this will be checked and fixed before next merge and/or on each commiters request.




> review and improve javadocs in ML module
> ----------------------------------------
>
>                 Key: IGNITE-5018
>                 URL: https://issues.apache.org/jira/browse/IGNITE-5018
>             Project: Ignite
>          Issue Type: Task
>            Reporter: Oleg Ignatenko
>            Assignee: Oleg Ignatenko
>            Priority: Minor
>             Fix For: 2.0
>
>
> Review and improve javadocs in Ignite ML module (added per IGNITE-4572). To name a few, add descriptions for constructor parameters in classes {{CacheMatrix}}, {{CacheMatrixStorage}}, {{RandomVector}}. Etc.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)