You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@couchdb.apache.org by "Dale Harvey (JIRA)" <ji...@apache.org> on 2010/11/09 14:50:11 UTC

[jira] Created: (COUCHDB-943) Reformat comments with type specs and @doc directives

Reformat comments with type specs and @doc directives
-----------------------------------------------------

                 Key: COUCHDB-943
                 URL: https://issues.apache.org/jira/browse/COUCHDB-943
             Project: CouchDB
          Issue Type: Bug
          Components: Documentation
            Reporter: Dale Harvey
            Priority: Minor
         Attachments: format_comments.patch

Start introducing consistent use of @doc directives and type specifications, makes it easier to use dialyzer and ensures the comments show up in generated documentation. 

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


[jira] Updated: (COUCHDB-943) Reformat comments with type specs and @doc directives

Posted by "Dale Harvey (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/COUCHDB-943?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Dale Harvey updated COUCHDB-943:
--------------------------------

    Attachment: format_comments.patch

> Reformat comments with type specs and @doc directives
> -----------------------------------------------------
>
>                 Key: COUCHDB-943
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-943
>             Project: CouchDB
>          Issue Type: Bug
>          Components: Documentation
>            Reporter: Dale Harvey
>            Priority: Minor
>         Attachments: format_comments.patch
>
>
> Start introducing consistent use of @doc directives and type specifications, makes it easier to use dialyzer and ensures the comments show up in generated documentation. 

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


[jira] Closed: (COUCHDB-943) Reformat comments with type specs and @doc directives

Posted by "Dale Harvey (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/COUCHDB-943?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Dale Harvey closed COUCHDB-943.
-------------------------------

    Resolution: Not A Problem

Too old too apply, better done while developing anyway

> Reformat comments with type specs and @doc directives
> -----------------------------------------------------
>
>                 Key: COUCHDB-943
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-943
>             Project: CouchDB
>          Issue Type: Bug
>          Components: Documentation
>            Reporter: Dale Harvey
>            Priority: Minor
>         Attachments: format_comments.patch
>
>
> Start introducing consistent use of @doc directives and type specifications, makes it easier to use dialyzer and ensures the comments show up in generated documentation. 

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] Commented: (COUCHDB-943) Reformat comments with type specs and @doc directives

Posted by "Jan Lehnardt (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/COUCHDB-943?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12934263#action_12934263 ] 

Jan Lehnardt commented on COUCHDB-943:
--------------------------------------

No longer applies to trunk, can you update the patch?

> Reformat comments with type specs and @doc directives
> -----------------------------------------------------
>
>                 Key: COUCHDB-943
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-943
>             Project: CouchDB
>          Issue Type: Bug
>          Components: Documentation
>            Reporter: Dale Harvey
>            Priority: Minor
>         Attachments: format_comments.patch
>
>
> Start introducing consistent use of @doc directives and type specifications, makes it easier to use dialyzer and ensures the comments show up in generated documentation. 

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


[jira] Commented: (COUCHDB-943) Reformat comments with type specs and @doc directives

Posted by "Adam Kocoloski (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/COUCHDB-943?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12930135#action_12930135 ] 

Adam Kocoloski commented on COUCHDB-943:
----------------------------------------

Great patch Dale.   This has been on my todo list for far too long.

> Reformat comments with type specs and @doc directives
> -----------------------------------------------------
>
>                 Key: COUCHDB-943
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-943
>             Project: CouchDB
>          Issue Type: Bug
>          Components: Documentation
>            Reporter: Dale Harvey
>            Priority: Minor
>         Attachments: format_comments.patch
>
>
> Start introducing consistent use of @doc directives and type specifications, makes it easier to use dialyzer and ensures the comments show up in generated documentation. 

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