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

Side by Side 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.
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 /**
19 * @mainpage Libadblockplus source code documentation
20 * 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
21 * build instructions and basic usage.
22 */
23
24 /**
25 * @namespace AdblockPlus
26 * Main namespace of Libadblockplus.
27 */
28
18 #ifndef ADBLOCK_PLUS_ADBLOCK_PLUS_H 29 #ifndef ADBLOCK_PLUS_ADBLOCK_PLUS_H
19 #define ADBLOCK_PLUS_ADBLOCK_PLUS_H 30 #define ADBLOCK_PLUS_ADBLOCK_PLUS_H
20 31
21 #include <AdblockPlus/AppInfo.h> 32 #include <AdblockPlus/AppInfo.h>
22 #include <AdblockPlus/FileSystem.h> 33 #include <AdblockPlus/FileSystem.h>
23 #include <AdblockPlus/DefaultLogSystem.h> 34 #include <AdblockPlus/DefaultLogSystem.h>
24 #include <AdblockPlus/DefaultFileSystem.h> 35 #include <AdblockPlus/DefaultFileSystem.h>
25 #include <AdblockPlus/DefaultWebRequest.h> 36 #include <AdblockPlus/DefaultWebRequest.h>
26 #include <AdblockPlus/FilterEngine.h> 37 #include <AdblockPlus/FilterEngine.h>
27 #include <AdblockPlus/LogSystem.h> 38 #include <AdblockPlus/LogSystem.h>
28 #include <AdblockPlus/JsEngine.h> 39 #include <AdblockPlus/JsEngine.h>
29 #include <AdblockPlus/JsValue.h> 40 #include <AdblockPlus/JsValue.h>
30 #include <AdblockPlus/ReferrerMapping.h> 41 #include <AdblockPlus/ReferrerMapping.h>
31 #include <AdblockPlus/WebRequest.h> 42 #include <AdblockPlus/WebRequest.h>
32 43
33 #endif 44 #endif
OLDNEW
« 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