To comment on the following update, log in, then open the issue:
http://www.openoffice.org/issues/show_bug.cgi?id=82916
Issue #|82916
Summary|autodoc should allow "makros" in the documentation
Component|tools
Version|OOo 2.3
Platform|All
URL|
OS/Version|All
Status|NEW
Status whiteboard|
Keywords|
Resolution|
Issue type|ENHANCEMENT
Priority|P3
Subcomponent|autodoc
Assigned to|np
Reported by|fs
------- Additional comments from [EMAIL PROTECTED] Wed Oct 24 10:10:19 +0000
2007 -------
There's some scenarios in IDL documentation where the same (non-trivial) text
needs to be written in multiple place. For instance, consider the following:
service Foo
{
create( [in] string Bar );
createWithSomething( [in] string Bar, [in] string Something );
}
The parameter Bar needs to be documented at both constructors. If this
documentation is halway complex, this leads to a lot of duplicated text, which
is prone to getting out of sync over time.
Autodoc should allow for some kind of "makros" or "templates" or however you
call it:
@template documentBar {
@param Bar
is needed for ...
}
...
@documentBar
(The syntax is certainly debatable, but you get the idea.)
That would help a lot in writing good, consistent, error-proof IDL
documentation.
---------------------------------------------------------------------
Please do not reply to this automatically generated notification from
Issue Tracker. Please log onto the website and enter your comments.
http://qa.openoffice.org/issue_handling/project_issues.html#notification
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
