include/AdblockPlus/AppInfo.h - Issue 5728380594946048: Issue 116 - Document the libadblockplus API

Delta Between Two Patch Sets: include/AdblockPlus/AppInfo.h

Issue 5728380594946048: Issue 116 - Document the libadblockplus API (Closed)

Left Patch Set: Created Aug. 28, 2014, 4:14 p.m.

Right Patch Set: Write libadblockplus in lower case consistently Created Sept. 2, 2014, 2:18 p.m.

Left:
Right:

Use n/p to move between diff chunks; N/P to move between comments.

Jump to:

Left: Side by side diff | Download
Right: Side by side diff | Download

LEFT	RIGHT
1 /*	1 /*

2 * This file is part of Adblock Plus <http://adblockplus.org/>,	2 * This file is part of Adblock Plus <http://adblockplus.org/>,

3 * Copyright (C) 2006-2014 Eyeo GmbH	3 * Copyright (C) 2006-2014 Eyeo GmbH

4 *	4 *

5 * Adblock Plus is free software: you can redistribute it and/or modify	5 * Adblock Plus is free software: you can redistribute it and/or modify

6 * it under the terms of the GNU General Public License version 3 as	6 * it under the terms of the GNU General Public License version 3 as

7 * published by the Free Software Foundation.	7 * published by the Free Software Foundation.

8 *	8 *

9 * Adblock Plus is distributed in the hope that it will be useful,	9 * Adblock Plus is distributed in the hope that it will be useful,

10 * but WITHOUT ANY WARRANTY; without even the implied warranty of	10 * but WITHOUT ANY WARRANTY; without even the implied warranty of

(...skipping 11 matching lines...) Expand all Loading...
22	22

23 namespace AdblockPlus	23 namespace AdblockPlus

24 {	24 {

25 /**	25 /**

26 * Information about the app using libadblockplus.	26 * Information about the app using libadblockplus.

27 */	27 */

28 struct AppInfo	28 struct AppInfo

29 {	29 {

30 /**	30 /**

31 * Optional unique ID of the app.	31 * Optional unique ID of the app.

	32 * @deprecated This field is not used anywhere, and will be removed.

32 */	33 */

33 std::string id;	34 std::string id;
Wladimir Palant 2014/08/28 17:24:40 Didn't we want to remove this? This is the ID used Didn't we want to remove this? This is the ID used by the platform to identify the app, it makes fairly little sense in libadblockplus... The only place where this is actually used seems to be the code integrating with the Firefox Add-ons Manager. Felix Dahlke 2014/08/28 22:56:41 Yup, came to the same conclusion, but I'd rather n Show quoted text On 2014/08/28 17:24:40, Wladimir Palant wrote: > Didn't we want to remove this? This is the ID used by the platform to identify > the app, it makes fairly little sense in libadblockplus... The only place where > this is actually used seems to be the code integrating with the Firefox Add-ons > Manager. Yup, came to the same conclusion, but I'd rather not mix such a change with adding documentation. Created #1284 for that.
34	35

35 /**	36 /**

36 * Current version of the app, in	37 * Current version of the app, in

37 * [Mozilla toolkit version format](https://developer.mozilla.org/en/docs/To olkit_version_format).	38 * [Mozilla toolkit version format](https://developer.mozilla.org/en/docs/To olkit_version_format).

38 */	39 */

39 std::string version;	40 std::string version;

40	41

41 /**	42 /**

42 * Name of the app, e.g.\ _adblockplus_.	43 * Technical name of the app (not user visible).
Wladimir Palant 2014/08/28 17:24:40 This should stress the fact that it is a codename, This should stress the fact that it is a codename, not the user-visible name. Also, please don't give embedders the idea to actually use "adblockplus" here - "mygreatapp" should be better. Felix Dahlke 2014/08/28 22:56:41 Done. Show quoted text On 2014/08/28 17:24:40, Wladimir Palant wrote: > This should stress the fact that it is a codename, not the user-visible name. > Also, please don't give embedders the idea to actually use "adblockplus" here - > "mygreatapp" should be better. Done.
43 */	44 */

44 std::string name;	45 std::string name;

45	46

46 /**	47 /**

47 * Name of the platform, e.g.\ _msie64_.	48 * Technical name of the platform the app is running on (not user visible).
Wladimir Palant 2014/08/28 17:24:40 "platform that the app is running on" "platform that the app is running on" Felix Dahlke 2014/08/28 22:56:41 Done. Show quoted text On 2014/08/28 17:24:40, Wladimir Palant wrote: > "platform that the app is running on" Done.
48 */	49 */

49 std::string application;	50 std::string application;

50	51

51 /**	52 /**

52 * Current version of the platform	53 * Current version of the platform the app is running on.

53 */	54 */

54 std::string applicationVersion;	55 std::string applicationVersion;

55	56

56 /**	57 /**

57 * Locale to use, as a	58 * Locale to use, as a

58 * [Mozilla locale code](https://wiki.mozilla.org/L10n:Locale_Codes).	59 * [Mozilla locale code](https://wiki.mozilla.org/L10n:Locale_Codes).

59 */	60 */

60 std::string locale;	61 std::string locale;

61	62

62 /**	63 /**

63 * Whether the app is a development build, the default is `false`.	64 * Whether the app is a development build, the default is `false`.

64 */	65 */

65 bool developmentBuild;	66 bool developmentBuild;

66	67

67 AppInfo() : developmentBuild(false) {}	68 AppInfo() : developmentBuild(false) {}

68 };	69 };

69 }	70 }

70	71

71 #endif	72 #endif

LEFT	RIGHT