Bug 115507 – [EFL] Correct documentation for ewk_settings APIs

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

[Jose Lejin PJ]

Some of the APIs documentation wrong in ewk_settings APIs.

1)EAPI const char      *ewk_settings_web_database_path_get(void);
 * By default, the value is @c ~/.webkit

2)EAPI void ewk_settings_local_storage_path_set(const char* path);
  EAPI const char* ewk_settings_local_storage_path_get(void);
 * By default, the value is @c ~/.webkit

3)EAPI const char      *ewk_settings_application_cache_path_get(void);
 * By default, the path is @c NULL, indicating that the feature is disabled.

[Jose Lejin PJ]

Created attachment 200302 [details]
Patch

[Jose Lejin PJ]

(In reply to comment #1)
> Created an attachment (id=200302) [details]
> Patch

Please comment if any other documentation to be corrected with this bug.

[Kangil Han]

LGTM, thanks!

[Gyuyoung Kim]

Comment on attachment 200302 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=200302&action=review

> Source/WebKit/efl/ewk/ewk_settings.h:60
> + * By default, the value is @c $HOME/.cache/WebKitEfl/Databases

Doesn't "/" mean home directory ? It looks "~/" is more simple than $HOME.

> Source/WebKit/efl/ewk/ewk_settings.h:-200
> - * By default, the path is @c NULL, indicating that the feature is disabled. Once the path is set, the feature is enabled

>> Once the path is set, the feature is enabled and the path cannot be changed

Why do you remove existing comment ? Isn't this comment still valid ?

[Jose Lejin PJ]

(In reply to comment #4)
> (From update of attachment 200302 [details])
> View in context: https://bugs.webkit.org/attachment.cgi?id=200302&action=review
> 
> > Source/WebKit/efl/ewk/ewk_settings.h:60
> > + * By default, the value is @c $HOME/.cache/WebKitEfl/Databases
> 
> Doesn't "/" mean home directory ? It looks "~/" is more simple than $HOME.
I will correct this to  ~/
> 
> > Source/WebKit/efl/ewk/ewk_settings.h:-200
> > - * By default, the path is @c NULL, indicating that the feature is disabled. Once the path is set, the feature is enabled
> 
> >> Once the path is set, the feature is enabled and the path cannot be changed
> 
> Why do you remove existing comment ? Isn't this comment still valid ?

I will add this "Once the path is set, the feature is enabled and the path cannot be changed"

[Jose Lejin PJ]

Created attachment 201034 [details]
Patch

Updated patch

[WebKit Commit Bot]

Comment on attachment 201034 [details]
Patch

Clearing flags on attachment: 201034

Committed r149719: <http://trac.webkit.org/changeset/149719>

[WebKit Commit Bot]

All reviewed patches have been landed.  Closing bug.