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

Keyboard Shortcuts

	File
u :	up to issue
m :	publish + mail comments
M :	edit review message
j / k :	jump to file after / before current file
J / K :	jump to next file with a comment after / before current file
	Side-by-side diff
i :	toggle intra-line diffs
e :	expand all comments
c :	collapse all comments
s :	toggle showing all comments
n / p :	next / previous diff chunk or comment
N / P :	next / previous comment
<Up> / <Down> :	next / previous line
<Enter> :	respond to / edit current comment
d :	mark current comment as done

	Issue
u :	up to list of issues
m :	publish + mail comments
j / k :	jump to patch after / before current patch
o / <Enter> :	open current patch in side-by-side view
i :	open current patch in unified diff view

	Issue List
j / k :	jump to issue after / before current issue
o / <Enter> :	open current issue
# :	close issue

	Comment/message editing
<Ctrl> + s or <Ctrl> + Enter :	save comment
<Esc> :	cancel edit

Delta Between Two Patch Sets: include/AdblockPlus.h

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

Left Patch Set: Documented the remaining relevant files Created Aug. 29, 2014, 4:36 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

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 /**	18 /**

19 * @mainpage Libadblockplus source code documentation	19 * @mainpage libadblockplus source code documentation

20 * This is the source code documentation of Libadblockplus. See the README for	20 * This is the source code documentation of libadblockplus. See the

21 * build instructions and basic usage.	21 * <a href="https://hg.adblockplus.org/libadblockplus/file/default/README.md">RE ADME</a>

	22 * for build instructions and basic usage.

22 */	23 */

23	24

24 /**	25 /**

25 * @namespace AdblockPlus	26 * @namespace AdblockPlus

26 * Main namespace of Libadblockplus.	27 * Main namespace of libadblockplus.

27 */	28 */

28	29

29 #ifndef ADBLOCK_PLUS_ADBLOCK_PLUS_H	30 #ifndef ADBLOCK_PLUS_ADBLOCK_PLUS_H

30 #define ADBLOCK_PLUS_ADBLOCK_PLUS_H	31 #define ADBLOCK_PLUS_ADBLOCK_PLUS_H

31	32

32 #include <AdblockPlus/AppInfo.h>	33 #include <AdblockPlus/AppInfo.h>

33 #include <AdblockPlus/FileSystem.h>	34 #include <AdblockPlus/FileSystem.h>

34 #include <AdblockPlus/DefaultLogSystem.h>	35 #include <AdblockPlus/DefaultLogSystem.h>

35 #include <AdblockPlus/DefaultFileSystem.h>	36 #include <AdblockPlus/DefaultFileSystem.h>

36 #include <AdblockPlus/DefaultWebRequest.h>	37 #include <AdblockPlus/DefaultWebRequest.h>

37 #include <AdblockPlus/FilterEngine.h>	38 #include <AdblockPlus/FilterEngine.h>

38 #include <AdblockPlus/LogSystem.h>	39 #include <AdblockPlus/LogSystem.h>

39 #include <AdblockPlus/JsEngine.h>	40 #include <AdblockPlus/JsEngine.h>

40 #include <AdblockPlus/JsValue.h>	41 #include <AdblockPlus/JsValue.h>

41 #include <AdblockPlus/ReferrerMapping.h>	42 #include <AdblockPlus/ReferrerMapping.h>

42 #include <AdblockPlus/WebRequest.h>	43 #include <AdblockPlus/WebRequest.h>

43	44

44 #endif	45 #endif

LEFT	RIGHT