The problem with star delimited unordered lists was in appledoc comment preprocessor which consumed single star and replaced them with double star markers so that text would be emitted in bold. That's actually a feature of appledoc which allows single stars be used for bold markers, but may break compatibility with Markdown as the result. As there's no reliable way of determining whether the user wants to have star delimited, I decided to go the route I had in my mind for some time now: introduce another command line switch that would prevent handling single stars. It's on/off solution, so not the best one, but everyone can choose at least... Also updated [online documentation](http://gentlebytes.com/appledoc-docs-examples-basic/index.html#compatibility) with example of using the new switch. **Important:** As of this version on, single star handling is **off** by default! This may break backwards compatibility with some folks, but I feel it's better to keep as Markdown compatible for new people as possible...
**Note:** Should convert to sen test as it's supported natively by Xcode 4 and provides much better IDE integration...
The problem was with recent support for termination macros: originally appledoc always took the last component for property name, but that's obviously not working for termination macros. So the new code took the second component which broke cases like `IBOutlet UIView *name`. To compensate, the code now tries to handle the stuff more intelligently. **Note:** Just a side note: recent pull requests broke several unit tests, including method/property handling ones, so there might be additional incompatibilities! Will need to check those too!
When using `@see` to link in companion guides inside a class/category/protocol comment, appledoc tried to create related object description inside the token xml file. But the code that was creating token only handled classes, categories, protocols and their members; when other type of object was encountered (i.e. static document/companion guide), the method token generation was assumed which failed due to missing data. Anyway, the fix introduced here first checks all (currently) supported object types and returns `nil` for unsupported types, then the code that prepares data for template renderer checks for `nil` and only adds related object if there is some.
Fixes protocols support in properties. Closes #148. Thanks to [lcpromptu](https://github.com/lcpromptu)!
Follow up to tomaz/appledoc#144
…on macros. It is now directly set by GBObjectiveCParser.
Added support for termination macros for method declaration and properties declaration
Fixed typo in log message: "Checking for known superclasses and adopted p
Scripts for quick installation.
If TEMPLATES_DIR existed script copied Templates directory instead of its content there
Added install-appledoc.sh script that can be used to quickly install appledoc. It can be invoked from terminal with "sudo sh install-appledoc.sh" command. By default, it installs binary to /usr/local/bin and templates to ~/.appledoc. This directories can be overridden with -b and -t options respectively.
**Note:** This should resolve the issue, although the whole processing of single asterisk as bold marker makes the code quite fragile. The best solution would be to revert to standard Markdown and stop handling single asterisk as bold. This might break existing users comments somewhat, but should provide more stable platform for the future...
The problem was in tokens.xml files which used only class name when composing identifier strings for categories and their members. Note: My quick testing confirms this working, but if anyone experiences issues with category members, let me know - either comment this issue or create a new one.
Added support for excluding paths from the output. Use `--exclude-output` option for entering all paths that should be parsed, but excluded from generated output. Although this is similar to `--ignore`, there's one important difference: Ignore option will simply prevent any parsing happening over specified files or folders, hence it will result in warnings in case symbols from these paths are referenced in documentation that gets parsed. Exclude parses specified files or folders, but it simply doesn't output them, therefore you get no warnings. It's somewhat slower on the other hand due to having to parse extra files.
This is useful if you only want to generate documentation for certain sources but those sources depend on other sources that should not have documentation generated for them. With this feature, you add all sources as input and exclude certain sources from output generation. It will hide warnings on excluded sources, not generate output for them, but they will be used for merging with your included sources (eg. inheritance etc.)
Added a stylesheet to allow printing the doc.
- Improved the different templates with the standard appledoc header (merged from rasterize/appledoc). - Added the projectCompany and projectName template variable to all template document
Fix appledoc #122 ( #122 ) The issue was that the string sent to Discount was relying on the [str length] method which return the number of characters instead of returning the number of bytes in the UTF8 string. After that, the converted markdown string was converted back to obj-c string using ASCII encoding which was breaking everything. - Add a test case for UTF8 string handling
Using @since or @available comment in a method description will generate a new section in the method doc. called "Availability". The content of that section will be the text following the @since or @available tag.
…ppledoc's home page.
…ass method. Closes #90. This was working when instance method was registered first and class method with the same name was merged on it later on. But it didn't handle the other ordering. Hopefully this will allow handling all cases. Note that there might still be cases when merging properties and class methods - keep in mind if the issue get's re-opened. Also updated build number to 703.
…partially easing #107. Note: unfortunately it wasn't possible to continue indexing remaining files after encountering an error - docsetutil takes path to docset bundle, not individual files. So all symbols in the offending file AND all symbols in subsequent files will not be indexed. Also note that appledoc will log a warning and hence exit with code 1 in case it gets these errors! You'll probably want to use `--exit-threshold 2` or more if you're running from Xcode build script. For the moment, the only "workaround" is to stay clear of using these symbols in your own documentation. If you're using third party libraries or frameworks containing these symbols and only running them through appledoc to get similar looking docs encountering issues, you can only pass it through `--create-html` phase. If you want to have it integrated in Xcode, then go ahead and experiment to see how much of it is usable...