search

hanya / MRI

An object introspection tool for OpenOffice API
http://extensions.openoffice.org/en/project/MRI
Apache License 2.0
46 stars 7 forks source link

Full support of link with anchor to methods having multiple arguments for Doxygen based API reference #3

Closed hanya closed 9 years ago

hanya commented 9 years ago

Type name of the complex type can be abbreviated when the type is defined in the same module. This is the optional way and not unified in the files. Doxygen uses written type name even they are abbreviated or not in the definition. And there is no way to know the type is abbreviated or not in the specific IDL file through the API.

The way to solve is parsing IDL files.

hanya commented 9 years ago

sdk/docs/idl/ref/search directory of the SDK contains some generated index files with link having anchor. JavaScript files can be converted into JSON and can be read to look up inside.

Since these files contains all entries for keywords, they can be used to get link and anchor always. But loading files is heavier task than just constructing link and anchor. Just only for the situation when a keyword might contain abbreviated type name would be preffered.

hanya commented 9 years ago

When type name might be abbreviated, index file for the word is used to obtain the link to the word. On version 1.2.4.