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

Unified Diff: include/AdblockPlus.h

Issue 5728380594946048: Issue 116 - Document the libadblockplus API (Closed)
Patch Set: Document JsValue and FilterEngine Created Aug. 29, 2014, 1:18 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.h
===================================================================
--- a/include/AdblockPlus.h
+++ b/include/AdblockPlus.h
@@ -15,6 +15,17 @@
* along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>.
*/
+/**
+ * @mainpage Libadblockplus source code documentation
+ * This is the source code documentation of Libadblockplus. See the README for
Wladimir Palant 2014/08/29 18:18:50 "README file"? Not sure how helpful this hint is h
Felix Dahlke 2014/09/01 17:00:15 Yeah, it's for the web readable documentation. It
+ * build instructions and basic usage.
+ */
+
+/**
+ * @namespace AdblockPlus
+ * Main namespace of Libadblockplus.
+ */
+
#ifndef ADBLOCK_PLUS_ADBLOCK_PLUS_H
#define ADBLOCK_PLUS_ADBLOCK_PLUS_H
« no previous file with comments | « Makefile ('k') | include/AdblockPlus/AppInfo.h » ('j') | include/AdblockPlus/FilterEngine.h » ('J')

Powered by Google App Engine
This is Rietveld