Skip to content

Commit 6be8f4c

Browse files
committed
Update README.md
1 parent 9977999 commit 6be8f4c

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
## What is this?
55

6-
Writing document is so important for developing, but it is really painful with Xcode. Think about how much time you are wasting in pressing '*' or '/', and typing the parameters again and again. Now, you can find the method (or any code) you want to document to, and type in `///`, the document will be generated for you and all params and return will be extracted into a beatiful Javadoc style. You can just fill the inline placeholders to finish your document。
6+
Writing document is so important for developing, but it is really painful with Xcode. Think about how much time you are wasting in pressing '*' or '/', and typing the parameters again and again. Now, you can find the method (or any code) you want to document to, and type in `///`, the document will be generated for you and all params and return will be extracted into a Javadoc style, which is compatible with both [appledoc](https://github.com/tomaz/appledoc) and [Doxygen](http://www.stack.nl/~dimitri/doxygen/). You can just fill the inline placeholders to finish your document。
77

88
Here is an image which can show what it exactly does.
99

0 commit comments

Comments
 (0)