Re: [CrystalSpace] #979: imap/loader.h has wrong documentation brackets

#979: imap/loader.h has wrong documentation brackets
---------------------------+------------------------------------------------
 Reporter:  ralphcampbell  |       Owner:  sunshine
     Type:  defect         |      Status:  accepted
 Priority:  minimal        |   Milestone:          
Component:  documentation  |     Version:  V2.1    
 Keywords:                 |  
---------------------------+------------------------------------------------
Description changed by sunshine:

Old description:

> In include/imap/loader.h, the annotation for automatic documentation like
> doxygen has mismatching brackets.
>
> {{{
> Index: include/imap/loader.h
> ===================================================================
> --- include/imap/loader.h       (revision 39401)
> +++ include/imap/loader.h       (working copy)
> @@ -583,7 +583,7 @@
>    THREADED_INTERFACE4(LoadShader, const char* cwd, const char* filename,
> bool r
> egisterShader = true,
>    bool do_verbose = false);
>
> -  //@}
> +  //@{
>    /**
>     * Load a map file. If 'clearEngine' is true then the current contents
>     * of the engine will be deleted before loading.
> @@ -722,7 +722,7 @@
>    THREADED_INTERFACE7(LoadLibrary, const char* cwd, csRef<iDocumentNode>
> lib_no
> de, csRef<iCollection> collection = 0,
>    csRef<iStreamSource> ssource = 0, csRef<iMissingLoaderData>
> missingdata = 0,
> uint keepFlags = KEEP_ALL,
>    bool do_verbose = false);
> -  //@)
> +  //@}
>
>    //@{
>    /**
> }}}

New description:

 In `include/imap/loader.h`, the annotation for automatic documentation
 like Doxygen has mismatching brackets.

 {{{
 Index: include/imap/loader.h
 ===================================================================
 --- include/imap/loader.h       (revision 39401)
 +++ include/imap/loader.h       (working copy)
 @@ -583,7 +583,7 @@
    THREADED_INTERFACE4(LoadShader, const char* cwd, const char* filename,
 bool r
 egisterShader = true,
    bool do_verbose = false);

 -  //@}
 +  //@{
    /**
     * Load a map file. If 'clearEngine' is true then the current contents
     * of the engine will be deleted before loading.
 @@ -722,7 +722,7 @@
    THREADED_INTERFACE7(LoadLibrary, const char* cwd, csRef<iDocumentNode>
 lib_no
 de, csRef<iCollection> collection = 0,
    csRef<iStreamSource> ssource = 0, csRef<iMissingLoaderData> missingdata
 = 0,
 uint keepFlags = KEEP_ALL,
    bool do_verbose = false);
 -  //@)
 +  //@}

    //@{
    /**
 }}}

--

-- 
Ticket URL: <http://trac.crystalspace3d.org/trac/CS/ticket/979#comment:2>
CrystalSpace <http://www.crystalspace3d.org/>
Free open-source 3D SDK.
------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:

Build for Windows Store.

http://p.sf.net/sfu/windows-dev2dev