I browsed the web today and found nice tool for generating documentation called Jazzy. I started working on documenting public, internal and private API to make it easy to understand, so also easy to extend in the future. After all is documented I'll push it to the repo and include link to the documentation in podspec file.
[x] Add note about documentation to the master repo with link to it.
Write documentation for:
[x] Expression
[x] ExpressionMatcher
[x] ExpressionParser
[x] InequalityExpressionMatcher
[x] InequalityExpressionParser
[x] InequalityExtendedExpressionMatcher
[x] InequalityExtendedExpressionParser
[x] InequalitySign
[x] InternalPatterns (Change name to InternalPattern) !!!
[x] KeyValue
[x] LocalizableFilesLoader
[x] Regex
[x] RegexExpressionMatcher
[x] RegexExpressionParser
[x] SharedBaseExpression
[x] SharedExpression
[x] SharedPolishExpression
[x] Swifternalization
[x] SharedExpressionsConfigurator
[x] TranslatablePair
[x] ValueType
I am thinking how documentation should look like. Meaning, should it be only one version of documentation which cover public, internal and private classes, methods, enums, etc? Or would it be better to create one which contains entire framework and one just with public interface that will be used by people that want to just use the framework without looking what's going on inside? I think the latter is the better option.
If this is the correct and best approach I would like to create following files structure:
I browsed the web today and found nice tool for generating documentation called Jazzy. I started working on documenting public, internal and private API to make it easy to understand, so also easy to extend in the future. After all is documented I'll push it to the repo and include link to the documentation in podspec file.
You can find documentation in progress here on documentation branch.
Write documentation for:
I am thinking how documentation should look like. Meaning, should it be only one version of documentation which cover public, internal and private classes, methods, enums, etc? Or would it be better to create one which contains entire framework and one just with public interface that will be used by people that want to just use the framework without looking what's going on inside? I think the latter is the better option.
If this is the correct and best approach I would like to create following files structure:
docs/framework/... docs/public/...
Any advices, thoughts, comments?