appledoc
appledoc copied to clipboard
HTML templates no longer working properly
After noticing that ARC support had been merged in, I hacked the old homebrew formula to pull down and build HEAD, and pointed it at some of our app code:
appledoc \
--no-create-docset
--project-name Foo --project-company "Results Direct"
--keep-undocumented-objects --keep-undocumented-members
SourceDir
The generation process seemed to work at a macro level: it chewed through my source, warned me about things that didn't have documentation comments on them, and generated a bunch of HTML output files.
However, none of the class information ended up in those files. There is a <ClassName>.html file for each class, and it was clearly generated from the template, but none of the actual information about the class is present. I've posted an example as a Gist.
There are a couple of files generated with the constants template from enums in my code that do appear to be fully populated, FWIW.
Poking around a little more, it looks like maybe the changes to the templates for #498 are responsible. I'm not super-familiar with Mustache, but looking at the diff for object-template.html, there are a bunch of places where dots have been changed to slashes in the Mustache expressions (e.g. {{page.title}} to {{page/title}}). After changing those back to dots in my local copy of that file and re-running appledoc, I did have class information in the output.
Reverting those template expressions did get pretty much everything working again, it seems, but on the index and hierarchy pages, I'm still not seeing page title or section headers. The actual content and links are there, though.
Can you prepare pull request with your changes?
Opened PR #501.
Also, turns out that when I said index and hierarchy weren't working yet, I'd been editing the wrong copy of the templates. Code in the PR seems to be working much better.
Just wanted to confirm that fix. I had the same issue and its resolved by #501.
Great, just hit this on an update for CocoaDocs. Thanks for the #501 PR.
I want to comment that I have the latest on master as of Feb 14th, 2015 (which includes #501 PR). It exhibits the same issue. Running on Mac OS X 10.10.
@NSProgrammer Just in case: did you update template files?
Sorry for the delayed reply... Yes, I updated the template files. Well, rather, I pulled from master and verified that the templates were updated.
Same problem here!