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

Unified 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.
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: include/AdblockPlus/AppInfo.h
===================================================================
--- a/include/AdblockPlus/AppInfo.h
+++ b/include/AdblockPlus/AppInfo.h
@@ -22,14 +22,47 @@
namespace AdblockPlus
{
+ /**
+ * Information about the app using Libadblockplus.
+ */
struct AppInfo
{
+ /**
+ * Optional unique ID of the app.
+ * @deprecated This field is not used anywhere, and will be removed.
+ */
std::string id;
+
+ /**
+ * Current version of the app, in
+ * [Mozilla toolkit version format](https://developer.mozilla.org/en/docs/Toolkit_version_format).
+ */
std::string version;
+
+ /**
+ * Technical name of the app (not user visible).
+ */
std::string name;
+
+ /**
+ * Technical name of the platform the app is running on (not user visible).
+ */
std::string application;
+
+ /**
+ * Current version of the platform the app is running on.
+ */
std::string applicationVersion;
+
+ /**
+ * Locale to use, as a
+ * [Mozilla locale code](https://wiki.mozilla.org/L10n:Locale_Codes).
+ */
std::string locale;
+
+ /**
+ * Whether the app is a development build, the default is `false`.
+ */
bool developmentBuild;
AppInfo() : developmentBuild(false) {}

Powered by Google App Engine
This is Rietveld