Skip to content

Commit 4993b87

Browse files
committed
docs: Write documentation about filter rules
1 parent dd8df0d commit 4993b87

2 files changed

Lines changed: 34 additions & 0 deletions

File tree

docs/filterrules.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Filter rules
2+
3+
You can customize how CodeNav shows the code items in a document by creatin filter rules.
4+
A filter rule consists of three parts: A code item kind, modifiers and actions.
5+
6+
## Kind
7+
First select the kind of code item a rule should apply to (classs, method, namespace, etc...).
8+
9+
## Modifiers
10+
Secondly select a number of modifiers to narrow down the rule.
11+
12+
### Access
13+
Match code items by access (public, private, etc...)
14+
15+
### Empty
16+
Match code items that do not have visible child items
17+
18+
## Action
19+
Finally select then action to should be applied to the code item.
20+
21+
### Hide
22+
Code item, including any child items, will not be shown
23+
24+
### Ignore
25+
Code item will not be shown, but its child items will be shown
26+
27+
### Opacity
28+
Code items will be shown with the selected opacity, where 0 is transparent and 100 is opaque
29+
30+
## Notes
31+
- Not all modifiers and/or actions are available for each kind, the filter dialog will respond and enable the correct list of modifiers

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Welcome to the CodeNav documentation. Browse the sections below to learn more about the extension and its development.
44

5+
## Filter rulwa
6+
Read all on how to modify the appearance of code items usin [filter rules](filterrules.md)
7+
58
## Version 10
69
Read all about the new [version 10](version10.md) of CodeNav
710

0 commit comments

Comments
 (0)