[Webkit-unassigned] [Bug 84572] [EFL] Split ewk_private.h file to multiple private files.

bugzilla-daemon at webkit.org bugzilla-daemon at webkit.org
Fri May 11 04:56:19 PDT 2012


https://bugs.webkit.org/show_bug.cgi?id=84572





--- Comment #5 from Grzegorz Czajkowski <g.czajkowski at samsung.com>  2012-05-11 04:55:22 PST ---
(In reply to comment #4)
> (From update of attachment 141347 [details])
> View in context: https://bugs.webkit.org/attachment.cgi?id=141347&action=review
> 
> General comments:
> 
> When generating the docs, I'm getting documentation for a lot of private headers. I think the idea of private headers is exactly the opposite: hide from the users so we don't make any commitment on these APIs. 

In my opinion private stuff should be documented as well. Application developer has only public headers that are installed to WebKit package so he doesn't see any docs from private file.

In case of generating docs based on Ewk sources I think using doxgen tag 'internal' for each structure, function should satisfy us. It ensures that documentation won't be attached to the html files (it can be changed by edit doxygen config).
We can consider removing lines @file and @brief from private files. Then those files won't be included to final documentation.

-- 
Configure bugmail: https://bugs.webkit.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.



More information about the webkit-unassigned mailing list