Re: Some consistency in IDL please

On 29/10/2010 12:17, Bernard Marcelly wrote:
> Hello,
> This is not a problem, just an annoyance which could be avoided.
> 
> I downloaded the Dev SDK for version 3.3, and run a grep tool on all IDL files, 
> to find out which files contain the string : @since
> 
> The following remarks are also valid for previous versions.
> For the latest version 3.3.0 I found these variants, on various IDLs:
> 
> @since  OpenOffice.org 3.3
> @since OOo 3.3
> @since OOo 3.3.0
> @since OOo3.3
> @since OpenOffice.org 3.3
> 
> Please, API developers, could you stick to one rule ? :-)

yes, that would indeed be a good idea :)
can somebody (jsc?) please declare one of these as "correct"?

minor point: should we use 3.3 or 3.3.0?
i'd prefer 3.3, because micro releases tend not to introduce new APIs.

> Special comment for com/sun/star/text/TextMarkupType.idl which contains these:
> /// @since OOo 3.3
> /// @since OOo 3.0.1
> Not only are they invisible from a Browser, but they render invisible other 
> information. Which is incorrect, the IDL file, the IDL formatter, both?

afaik our stupid "autodoc" tool doesn't consider this "///" style of
comments worthy of its attention.

anybody want to replace autodoc with some doxygen configuration that
produces the same output?

another thing about autodoc i dislike is its tendency to handle invalid
input via infinite loops...

> Regards
>    Bernard

-- 
"The finger pointing at the moon is not the moon." -- Buddhist saying