[Webkit-unassigned] [Bug 65305] [EFL] Move ewk_view API documentation to the header file

Thu Jul 28 05:04:53 PDT 2011

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

Raphael Kubo da Costa <kubo at profusion.mobi> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |kubo at profusion.mobi

--- Comment #2 from Raphael Kubo da Costa <kubo at profusion.mobi>  2011-07-28 05:04:53 PST ---
The patch itself looks OK to me, but I have a few comments:

(In reply to comment #0)
> There are three arguments for this:
> 1. Dev package will contain all API description so developers
>    using webkit-efl-dev package don't need to check source code of cpp
>    files when they want to know how to use the given API.
> 2. Doxygen might generate documentation just using webkit-ef-dev package
>    so there will be no need to have WebKit sources.

Mentioning a package by name like that assumes it will always have that name in all distributions and whatnot. Personally, I would be more generic and just say that it is easier to check the apidox in the header, as people using webkit-efl from packages probably won't have the C files with them and the doxygen documentation can be generated from the headers without the need for the whole source files.

> If you agree with this idea I will prepare another patches for other ewk files soon.

Do you mean that there are other patches which move documentation in ewk? If so, wouldn't it be better to do that all at once?

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