Re: Re: Some consistency in IDL please

On 10/29/10 1:12 PM, Frank Schönheit wrote:
> Hi Michael,
> 
>>> @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"?
> 
> In the past, OOo was ignored by autodoc, and only the version number was
> taken, and translated (via some configurable translation table) into a
> "<product-name> <version>", for different product names.
> 
> In a not-too-recent past, it was decided to remove this translation
> table. I am not sure what the current state is - does autodoc really
> take the unmodified tokens after "@since" and puts them into the HTML
> file? This would have been a change for the worse then ...
> 
> So, in short: Formerly those different syntaxes were not a problem, if
> they are today, then ... it is worth an issue, for sure.
an issue is fine for me. I will check it and we can agree on one style,
for example @since OOo 3.3

> 
>> 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.
> 
> +1 (though for a different reason: the official name usually is "3.3",
> not "3.3.0")
+1
> 
>> anybody want to replace autodoc with some doxygen configuration that
>> produces the same output?
> 
> You made my day.
> 
> Should I forward you my archive of a 5-years-old discussion where we
> already attempted this. Is was a fight against windmills ...
> 
> Though, if somebody wants to embark on this, I'm on board.
> 
> Admittedly, my main interest is using doxygen for our C++/Java-code,
> something currently, in theory, also handled by autodoc.
+1 as well but the question is again who will do the work

> 
> autodoc for IDL is not as useless^Wbad as autodoc for C++, since it has
> additional features (like linking to the dev guide and the like) which
> might not be covered by current doxygen (/extensions).
exactly the links back into the DevGuide are useful at least from my
point of view.

Juergen