Issue 116191 - autodoc replaces "any" in css.beans.Pair arguments with "string"
Summary: autodoc replaces "any" in css.beans.Pair arguments with "string"
Status: REOPENED
Alias: None
Product: Build Tools
Classification: Code
Component: autodoc (show other issues)
Version: DEV300m94
Hardware: Sun All
: P3 Trivial (vote)
Target Milestone: ---
Assignee: AOO issues mailing list
QA Contact:
URL:
Keywords:
Depends on:
Blocks: 121168
  Show dependency tree
 
Reported: 2010-12-21 10:40 UTC by Frank Schönheit
Modified: 2013-08-07 15:34 UTC (History)
5 users (show)

See Also:
Issue Type: DEFECT
Latest Confirmation in: ---
Developer Difficulty: ---


Attachments

Note You need to log in before you can comment on or make changes to this issue.
Description Frank Schönheit 2010-12-21 10:40:08 UTC
See
http://api.openoffice.org/docs/common/ref/com/sun/star/container/EnumerableMap.html#createImmutable:
There, createImmutable is documented to take a "sequence< Pair< string, string >
>" parameter. In fact, looking into the respective IDL file, it is declared to
take a "sequence< Pair< any, any > >" parameter. So, autodoc loses this type
information when generating the HTML documentation form the IDL files.

(The online docu is based on 3.2 currently, but I reproduced the bug in a recent
DEV300.m94, too.)
Comment 1 Frank Schönheit 2010-12-21 10:41:18 UTC
targeting to 3.4. Our IDL reference should be accurate, at least as far as the
source IDL files are accurate, right?
Comment 2 mst.ooo 2010-12-22 08:33:11 UTC
@fs:
do you have an estimate how much work it would be
to switch the IDL docs to doxygen instead of
fixing all the silly bugs in autodoc?
Comment 3 Frank Schönheit 2010-12-22 08:39:16 UTC
@mst: Not at all. For C++, I think the effort would be bearable. Our C++ is
pretty standard :), and Novell (and now LO) uses doxygen for at least selected
modules for years now.
Sadly (well, in some sense), the IDL docu generated by autodoc has some more
features - the links to the dev guide  spring to my mind, there might be more,
Nikolai or Jürgen might be able to tell. I don't know enough 'bout doxygen to
know whether it supports plugins or something like that, allowing to implement
the same functionality there. I suppose it does, but ... we never came that far
last time we started the "doxygen vs. autodoc" discussion, since there was very
strong opposition against the idea of replacing the latter with the former.
Comment 4 nikolai.pretzell 2010-12-23 13:03:19 UTC
np->fs: Tested it with DEV300 m94, m96 and on CWS jsc340. Works for me in all
cases. Please, re-check.
Comment 5 nikolai.pretzell 2010-12-23 13:04:11 UTC
.
Comment 6 Frank Schönheit 2011-01-03 08:59:39 UTC
strange - doing this on DEV300m96, on some Linux, indeed gives me "pair< any,
any >". A IDL ref created from a current CWS of mine shows "pair< string, string
>" instead. Need to investigate.
Comment 7 Frank Schönheit 2011-02-14 12:17:19 UTC
fs->np:
Look at
DEV300/ooo.m99/odk/wntmsci12/bin/odkcommon/docs/common/ref/com/sun/star/container/EnumerableMap.html#createImmutable:
it also reads "Pair< string, string >" for the "Values" parameter, instead of
"Pair< any, any >". So, there's definitely something wrong here. Not sure if
this is a platform issue, since I agree it doesn't happen in all cases. But at
least it happens in an MWS build, it seems.
Comment 8 Frank Schönheit 2011-02-14 12:17:54 UTC
re-opening, see previous comment for the justification
Comment 9 bmarcelly 2012-10-10 09:51:28 UTC
Please note that structure com.sun.star.beans.Pair does not appear in the html pages reflecting the IDL contents!

Only com.sun.star.beans.StringPair does appear.

See
http://www.openoffice.org/api/docs/common/ref/com/sun/star/beans/module-ix.html
and see
http://www.openoffice.org/api/docs/common/ref/index-files/index-16.html