Skip to content

Commit da2f17d

Browse files
committed
Update doc.
1 parent d5cfffd commit da2f17d

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ document style. Let's try apply to language `TypeScript` only within
130130
## Advance Implementation
131131

132132
You are able to customize document string by running `before`/`after` hooks.
133-
The following are advance example for document string in `C++`.
133+
The following are advance examples for document string in `C++`.
134134

135135
| Preprocessor | Enumerator |
136136
|:--------------------------------------|:------------------------------------|
@@ -140,6 +140,34 @@ The following are advance example for document string in `C++`.
140140
|:--------------------------------------|:-------------------------------------|
141141
| <img src="./etc/c++/cpp-struct.gif"/> | <img src="./etc/c++/cpp-class.gif"/> |
142142

143+
## Document String
144+
145+
You are able to customize default document string by tweaking these variables.
146+
147+
### Varialbe Name
148+
149+
* `docstr-format-param` - Format string contain parameter data.
150+
* `docstr-format-return`
151+
152+
### Type Name
153+
154+
* `docstr-show-type-name`
155+
156+
If you don't want the type name to be shown; then set `docstr-show-type-name`
157+
to `nil` will make the trick. For instance, if you don't want the type name
158+
to be shown in `java-mode`; do the following.
159+
160+
```el
161+
(add-hook 'java-mode-hook (lambda () (setq-local docstr-show-type-name nil)))
162+
```
163+
164+
* `docstr-default-typename`
165+
166+
The default type name is `typename` that is assigned by `docstr-default-typename`.
167+
You can change this value as well if you don't like the default type name. This
168+
variable is generally use for programming languages that aren't strong type.
169+
Like `Python`, `JavaScript`, `PHP`, etc.
170+
143171
## Configure Faces
144172

145173
This package provides a way to customize the document string faces in a

0 commit comments

Comments
 (0)