Re: private, protected and public scope
- From: Stefan Kost <ensonic hora-obscura de>
- To: David Nečas <yeti physics muni cz>
- Cc: gtk-doc-list gnome org
- Subject: Re: private, protected and public scope
- Date: Fri, 16 Apr 2010 13:52:32 +0300
David Nečas wrote:
> On Sun, Jan 03, 2010 at 01:41:06PM +0200, Stefan Kost wrote:
>
>> gtkdoc supports scope comments (/*< private >*/) in structs (and now enums too)
>> to tailor what needs to be documented and what should appear in the docs. In the
>> past days I did a large refactoring to better track missing and unused
>> field/member/value docs. Now I found some examples that use "/*< protected >*/
>> to mark up some content as public for subclasses. What do we do with that in the
>> docs? Right now it is treated like private (and thus hidden). In the cases where
>> I found it, the fields where documented and thus one now gets warnings about
>> unused doc-strings.
>>
>> Any opinions?
>>
>
> Put them to the documentation and mark as protected (not sure how), i.e.
> only for subclassing. Not that it will stop people using them for other
> purposes but the intent will be clear.
>
> Yeti
>
The patch to change the behavour is trivial, but the result is not so
good either. Posted
https://bugzilla.gnome.org/show_bug.cgi?id=615935
for discussion.
Stefan
[
Date Prev][Date Next] [
Thread Prev][Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]