Skip to content

Commit a964cc3

Browse files
committed
[doc] 🎨 Improve features section
1 parent 4706993 commit a964cc3

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

docs/README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,15 @@ actionLink: /guide/
88
footer: MIT Licensed | Copyright © 2018-2019 Nelson Martell
99

1010
features:
11-
- title: Classes documentation
12-
details: Description, parents, interfaces and traits used, methods, properties, constants and more.
11+
- title: Document all your code
12+
details: Generate documentation for all your classes, interfaces and traits sorted by namespace. Also, include your global/namespaced functions and constants.
1313

14-
- title: Interfaces documentation
15-
details: Description, parent interfaces, methods, constants and more.
14+
- title: Easy integration
15+
details: Combine your API documentation with your existent VuePress pages by simply adding the 5 generated files to your sidebar configuration as a group.
1616

17-
- title: Traits documentation
18-
details: Description, used traits, methods, properties and more.
17+
- title: Linked references
18+
details: Navigate between classes/members references by just a click. Get references of inherited members
1919

20-
- title: Global constants
21-
details: Description, type, value and more.
22-
23-
- title: Global functions
24-
details: Description, signature, parameters and more.
20+
- title: Searchable elements
21+
details: Use the VuePress search in toolbar to find classes, interfaces, traits, functions and constants by name.
2522
---

0 commit comments

Comments
 (0)