[Libreoffice-bugs] [Bug 130978] New: Add a comment to each published API marking it as such

bugzilla-daemon at bugs.documentfoundation.org bugzilla-daemon at bugs.documentfoundation.org
Thu Feb 27 06:32:58 UTC 2020


https://bugs.documentfoundation.org/show_bug.cgi?id=130978

            Bug ID: 130978
           Summary: Add a comment to each published API marking it as such
           Product: LibreOffice
           Version: unspecified
          Hardware: All
                OS: All
            Status: UNCONFIRMED
          Keywords: difficultyBeginner, easyHack, skillCpp, topicCleanup
          Severity: enhancement
          Priority: medium
         Component: LibreOffice
          Assignee: libreoffice-bugs at lists.freedesktop.org
          Reporter: mikekaganski at hotmail.com
                CC: sbergman at redhat.com

A subset of LibreOffice source headers defines different parts of LibreOffice
published API. It would be good to have a standardized comment after the
license statement of those headers unambiguously mentioning that fact, so that
a developer could see immediately if this is part of published API or not. This
is required to clearly see what can be changed and what can't, or needs special
treatment, including public announcement of deprecation, using conditional
compilation for internal vs external usage, etc.

The task is: come up with a suggested comment and document it in README.md;
identify the published subset (communicating with developers in IRC and mailing
list); add the comment to all files in the subset.

-- 
You are receiving this mail because:
You are the assignee for the bug.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/libreoffice-bugs/attachments/20200227/638ca444/attachment-0001.htm>


More information about the Libreoffice-bugs mailing list