Bug 65305 – [EFL] Move ewk_view API documentation to the header file

• Status: RESOLVED
• Resolution: FIXED
• Component: WebKit EFL

[Grzegorz Czajkowski]

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.
3. It will be consistent with structures descriptions.


This patch only moves API documentation, it doesn't modify anything else.

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

[Grzegorz Czajkowski]

Created attachment 102232 [details]
proposed patch

[Raphael Kubo da Costa (:rakuco)]

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?

[Grzegorz Czajkowski]

(In reply to comment #2)
> 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.

Ok, I will fix a description.

> 
> > 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?

Yes, there are, but I wanted to avoid that huge patch. Besides currently only ewk_view is adjusted to EFL's style. If other files are ready I will move documentation for them. I suggest to submit three patches for this:
1. ewk_view
2. ewk_frame
3. other ewk_files
Is it ok?

[Raphael Kubo da Costa (:rakuco)]

If it's just moving comments around, I wouldn't mind a big patch that does it all. But if you prefer to split it, I'm fine with that too.

[Grzegorz Czajkowski]

Created attachment 102253 [details]
updated patch

fix description in ChangeLog

[Raphael Kubo da Costa (:rakuco)]

r+ from my side.

[Gyuyoung Kim]

Comment on attachment 102253 [details]
updated patch

LGTM

[Gyuyoung Kim]

Hello tkent. Could you please review this patch ? Sorry for adding CC. I think you can review this.

[WebKit Review Bot]

Comment on attachment 102253 [details]
updated patch

Clearing flags on attachment: 102253

Committed r91981: <http://trac.webkit.org/changeset/91981>

[WebKit Review Bot]

All reviewed patches have been landed.  Closing bug.

[Grzegorz Czajkowski]

Hello tkent,

I've added bug which moves remaining API documentaion to the header files. Could you review this patch, please? https://bugs.webkit.org/show_bug.cgi?id=65305

It may avoid merge conflicts if the patch will be commited asap. Thanks.

[Grzegorz Czajkowski]

(In reply to comment #11)
> Hello tkent,
> 
> I've added bug which moves remaining API documentaion to the header files. Could you review this patch, please? https://bugs.webkit.org/show_bug.cgi?id=65305
> 
> It may avoid merge conflicts if the patch will be commited asap. Thanks.

I am sorry for mistake, correct URL of bug https://bugs.webkit.org/show_bug.cgi?id=65373