Skip to content

Commit 8964a9f

Browse files
committed
Update doc.
1 parent 365c27f commit 8964a9f

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

README.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,12 @@ You are able to customize default document string by tweaking these variables.
146146

147147
### Type Name
148148

149-
* `docstr-show-type-name`
149+
* `docstr-format-type` - default to `"{ %s }"`
150+
151+
The default is wrap around curly brackets. It only takes one `%s` for type name
152+
to plug in.
153+
154+
* `docstr-show-type-name` - default to `t`
150155

151156
If you don't want the type name to be shown; then set `docstr-show-type-name`
152157
to `nil` will make the trick. For instance, if you don't want the type name
@@ -156,17 +161,33 @@ to be shown in `java-mode`; do the following.
156161
(add-hook 'java-mode-hook (lambda () (setq-local docstr-show-type-name nil)))
157162
```
158163

159-
* `docstr-default-typename`
164+
* `docstr-default-typename` - default to `typename`
160165

161-
The default type name is `typename` that is assigned by `docstr-default-typename`.
162-
You can change this value as well if you don't like the default type name. This
166+
You can change this value if you don't like the default type name. This
163167
variable is generally use for programming languages that aren't strong type.
164168
Like `Python`, `JavaScript`, `PHP`, etc.
165169

166170
### Variable Name
167171

168-
* `docstr-format-param` - Format string contain parameter data.
169-
* `docstr-format-return`
172+
* `docstr-format-var` - default to `"%s :"`
173+
174+
The default is having colon `:` at the back of the variable name. It only takes one
175+
`%s` for variable name to plug in.
176+
177+
### Parameter & Return
178+
179+
* `docstr-format-param` - default to `@param #T# #V# #D#`
180+
* `docstr-format-return` - default to `@return #T# #V# #D#`
181+
182+
You can customize this variable for different document style.
183+
184+
### Unique Keys
185+
186+
| Key | Description |
187+
|:------|:-----------------------------|
188+
| `#T#` | Key represent type name. |
189+
| `#V#` | Key represent variable name. |
190+
| `#D#` | Key represent description. |
170191

171192
## Configure Faces
172193

0 commit comments

Comments
 (0)