Skip to content

Commit b0cff86

Browse files
authored
FunctionList: clarify class as container
users are consistently confused by this. https://community.notepad-plus-plus.org/topic/22748/function-list-able-to-show-php-comments
1 parent 0335e51 commit b0cff86

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

content/docs/function-list.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ The `<classRange>` node accepts the following attributes and contained elements:
6565
- `functionNameExpr` (_element_): The element for the function name of a function inside a class. Please note that it uses the `functionNameExpr` element instead of the `nameExpr` element in the **Function parser**. Yes, it's confusing.
6666
- `expr` (_attribute_): this is where you put the regular expression defines what should match to be used in displaying the function name in the Function List panel.
6767

68+
_Please Note_: an empty class (one without any functions) will _not_ display in the Function List panel. Thus, if you have no `<function>` elements defined in your `<classRange>` node, you will _never_ see your class. And if you have a `<function>` defined, but it doesn't match any functions inside your class, the class will not be displayed in the FunctionList panel. In the FunctionList panel, the class is a container, and it will never display on its own if there is no function to display inside of it.
69+
6870
### Mixed parser
6971
A mixed parser contains a Class parser (`classRange` node) and a Function parser (`function` node). The Class parser will be applied first to find class zones, then the Function parser will be applied on non-class zones.
7072

0 commit comments

Comments
 (0)