Hi Jörg,
I am not sure what you refer to. The documentation has no influence on
backward compatibility.
According to current rules for Version numbers we must bump the first
digit if we do an API change.
So for Version 5 we must provide a Documentation a Version 4
Documentation and a Version 5 Documentation.
I think even if Version 5 is backward compatible with Version 4, the
documentation should be per Main Version.
I am fighting that we stick to the rule. (Actually I whish we only
change the first Digit if we have an API change. Which is a clear signal
to anyone what he has to look out for.
Current rules have a loophole to bumb for a majore release for features.
Which I do not see the benefit in. But this is maybe a different discussion)
It would be beneficial if we update the documentation with each release,
allowing a process that the documentation improves.
I think that means at current release speed we update API Documentation
once / twice a year. Which should not be to much effort?
I would not see documentation update as a blocker to a release thought.
Maybe even not part on the Release itself. But I think it is smart
to have both process in sync.
I think Arrigos Idea is a good one.
All the best
Peter
On 15.10.21 10:15, Jörg Schmidt wrote:
-----Original Message-----
From: Arrigo Marchiori [mailto:ard...@yahoo.it.INVALID]
Sent: Thursday, October 14, 2021 7:08 PM
To: dev@openoffice.apache.org
Subject: API doc on web site [Was: Accessing the comment
object (annotation) in Draw/Impress via API]
the API doc is (somehow) part of the website. And what you
are looking for
is maybe here:
https://github.com/apache/openoffice-org/blob/main/part2/conte
nt/api/docs/common/ref/com/sun/star/office/module-ix.html
Thank you! That is what I meant.
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.
-1 (for the moment)
this is only a good idea if there was a way to make backward compatibility,
because information is needed for all OO versions, not only for the current
version
please understand me correctly:
it's not about not changing anything, it's about not changing a whole procedure
without careful(!) examination just because there is an incorrect entry
Jörg
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@openoffice.apache.org
For additional commands, e-mail: dev-h...@openoffice.apache.org
--
This is the Way! http://www.apache.org/theapacheway/index.html
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@openoffice.apache.org
For additional commands, e-mail: dev-h...@openoffice.apache.org
