> -----Original Message----- > From: Arrigo Marchiori [mailto:ard...@yahoo.it.INVALID] > Sent: Monday, October 18, 2021 8:08 AM > To: dev@openoffice.apache.org > Subject: Re: API doc on web site [Was: Accessing the comment > object (annotation) in Draw/Impress via API] > > Hello All, > > replying to myself as a correction. > > On Thu, Oct 14, 2021 at 07:08:25PM +0200, Arrigo Marchiori wrote: > > [...] > > Those pages should be generated by Autodoc, for what I understand. > > > > Are there any scripts that do this? Or any policies on how > and when to > > update the API documentation? For example, I would suggest > that each > > new release would be a good time to update the API. > > I should have written "API documentation" instead of API. I apologize.
I assumed that 'API documentation' was meant, so all is well, no misunderstanding. > I agree that changing the API is a ``big thing'', that we shall be > very careful, and I understand Jörg's and Marcus' concern while > reading my paragraph above! > > I suggest we update the _documentation_ whenever possible because "whenever possible"? -1 'whenever necessary' +1 The difference between both things is a basic principle, e.g. in mechanical engineering (it is always worked as exactly as necessary, not as possible) as well as in programming, because one should not change any code (here documentation) if it is not necessary, because every change contains the risk of errors. > IMHO > that can be helpful for developers. Well, I've been professionally developing macros and extensions for OpenOffice for close to 15 years and I caution against frivolously updating the API documentation via automated processes until we have proper QA. Jörg --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@openoffice.apache.org For additional commands, e-mail: dev-h...@openoffice.apache.org
