Enhancement: issue error on all public functions that are missing ddoc sections

Walter Bright via Digitalmars-d digitalmars-d at puremagic.com
Fri Mar 20 16:40:03 PDT 2015


On 3/19/2015 3:26 PM, deadalnix wrote:
>     /**
>      * Send a message to the user. This can be used for commercial offers
>      * or general information about the system.
>      *
>      * msg: The message you wish to send to the user.
>      *
>      * @throw MessageNotSentException : If for some reason, the message isn't
>      * sent properly, a MessageNotSentException is sent.
>      */
>     sendMessage(string msg) { ... }

I'd write it as:

       /**
        * Send message to user. This can be used for commercial offers
        * or general information about the system. The user can receive these
        * messages with the [....] protocol.
        *
        * msg: the message
        *
        * @throw MessageNotSentException : possible reasons are [...]
        *
        * See_Also: receiveMessage()
        */
       sendMessage(string msg) { ... }



More information about the Digitalmars-d mailing list