Bug 115507 - [EFL] Correct documentation for ewk_settings APIs
Summary: [EFL] Correct documentation for ewk_settings APIs
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: WebKit EFL (show other bugs)
Version: 528+ (Nightly build)
Hardware: All All
: P2 Normal
Assignee: Nobody
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2013-05-01 23:10 PDT by Jose Lejin PJ
Modified: 2013-05-08 01:01 PDT (History)
6 users (show)

See Also:


Attachments
Patch (3.13 KB, patch)
2013-05-02 00:59 PDT, Jose Lejin PJ
no flags Details | Formatted Diff | Diff
Patch (3.21 KB, patch)
2013-05-08 00:26 PDT, Jose Lejin PJ
no flags Details | Formatted Diff | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Jose Lejin PJ 2013-05-01 23:10:07 PDT
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.
Comment 1 Jose Lejin PJ 2013-05-02 00:59:19 PDT
Created attachment 200302 [details]
Patch
Comment 2 Jose Lejin PJ 2013-05-02 01:00:09 PDT
(In reply to comment #1)
> Created an attachment (id=200302) [details]
> Patch

Please comment if any other documentation to be corrected with this bug.
Comment 3 Kangil Han 2013-05-03 06:02:39 PDT
LGTM, thanks!
Comment 4 Gyuyoung Kim 2013-05-08 00:01:08 PDT
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 ?
Comment 5 Jose Lejin PJ 2013-05-08 00:14:46 PDT
(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"
Comment 6 Jose Lejin PJ 2013-05-08 00:26:58 PDT
Created attachment 201034 [details]
Patch

Updated patch
Comment 7 WebKit Commit Bot 2013-05-08 01:01:45 PDT
Comment on attachment 201034 [details]
Patch

Clearing flags on attachment: 201034

Committed r149719: <http://trac.webkit.org/changeset/149719>
Comment 8 WebKit Commit Bot 2013-05-08 01:01:48 PDT
All reviewed patches have been landed.  Closing bug.