Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Side by Side Diff: include/AdblockPlus/AppInfo.h

Issue 5728380594946048: Issue 116 - Document the libadblockplus API (Closed)
Patch Set: Documented the remaining relevant files Created Aug. 29, 2014, 4:36 p.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View unified diff | Download patch
OLDNEW
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
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details. 12 * GNU General Public License for more details.
13 * 13 *
14 * You should have received a copy of the GNU General Public License 14 * You should have received a copy of the GNU General Public License
15 * along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>. 15 * along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>.
16 */ 16 */
17 17
18 #ifndef ADBLOCK_PLUS_APP_INFO_H 18 #ifndef ADBLOCK_PLUS_APP_INFO_H
19 #define ADBLOCK_PLUS_APP_INFO_H 19 #define ADBLOCK_PLUS_APP_INFO_H
20 20
21 #include <string> 21 #include <string>
22 22
23 namespace AdblockPlus 23 namespace AdblockPlus
24 { 24 {
25 /**
26 * Information about the app using Libadblockplus.
27 */
25 struct AppInfo 28 struct AppInfo
26 { 29 {
30 /**
31 * Optional unique ID of the app.
32 * @deprecated This field is not used anywhere, and will be removed.
33 */
27 std::string id; 34 std::string id;
35
36 /**
37 * Current version of the app, in
38 * [Mozilla toolkit version format](https://developer.mozilla.org/en/docs/To olkit_version_format).
39 */
28 std::string version; 40 std::string version;
41
42 /**
43 * Technical name of the app (not user visible).
44 */
29 std::string name; 45 std::string name;
46
47 /**
48 * Technical name of the platform the app is running on (not user visible).
49 */
30 std::string application; 50 std::string application;
51
52 /**
53 * Current version of the platform the app is running on.
54 */
31 std::string applicationVersion; 55 std::string applicationVersion;
56
57 /**
58 * Locale to use, as a
59 * [Mozilla locale code](https://wiki.mozilla.org/L10n:Locale_Codes).
60 */
32 std::string locale; 61 std::string locale;
62
63 /**
64 * Whether the app is a development build, the default is `false`.
65 */
33 bool developmentBuild; 66 bool developmentBuild;
34 67
35 AppInfo() : developmentBuild(false) {} 68 AppInfo() : developmentBuild(false) {}
36 }; 69 };
37 } 70 }
38 71
39 #endif 72 #endif
OLDNEW

Powered by Google App Engine
This is Rietveld