Ddoc and version

Derek Parnell derek at psyc.ward
Thu Aug 17 15:01:43 PDT 2006


On Thu, 17 Aug 2006 14:29:39 -0700, Sean Kelly wrote:


> 
> You can also document a function declaration:
> 
> version(XYZZY)
> {
>    /** Some description.
>     */
>    void someFunc();
> }
> else
> {
>    /** Some other description.
>     */
>    void someFunc();
> }
> 
> void someFunc()
> {
>    ...
> }
> 
> In a few cases I generate docs inside version(DDoc) blocks rather than 
> above the actual implementation, either because I have different 
> versions of a function for different platforms and I don't want to tie 
> the docs to a specific platform block, or because I'm using some dirty 
> trick to declare the function that I don't want the user to be aware of. 
>   This last case is most common in code where I'm hacking around ITI 
> limitations and the function decl doesn't exactly match what it 'should' be.

Hmmm ... I'll give it try. Thanks.

-- 
Derek Parnell
Melbourne, Australia
"Down with mediocrity!"



More information about the Digitalmars-d-bugs mailing list