search

tomaz / appledoc

Objective-c code Apple style documentation set generator.
http://gentlebytes.com
4.2k stars 644 forks source link

fix targeting for href deeplinks #570

Closed cestlou closed 8 years ago

cestlou commented 8 years ago

previously, the method of injection would leave the field empty (thus breaking the feature and making my tests angry). this is a hacky way of getting it to properly inject the method name.

tomaz commented 8 years ago

Thanks! Agree with you broken functionality wise, but not sure about the solution - hesitant to merge as it may hide the real problem which is how htmlLocalReference is generated/injected in code. That would ensure correct usage accross all files. Also, this is something you can easily apply on your local copy of templates as quick solution (--templates switch).

cestlou commented 8 years ago

Yep, I see your point. I'm not fluent in Obj-C but I will try to pair with someone who is to see about a fix. In the meantime, I was considering forking down and doing the hacky fix for the time being (we don't use appledocs much, only for 2-3 pages), could you explain a little more about this templates switch you're recommending?

tomaz commented 8 years ago

Ahh, totally missed your question... :/ By default appledoc uses builtin templates, but you can copy those to any path, change them as you see fit and use --templates switch to point appledoc to this path. Then your copy of templates will be used instead of default ones. This way you can affect the outcome by applying your proposed solution or anything else.

I'm closing this pull request for the moment, feel free to reopen if you come up with alternative solution. Also take a look at http://www.gentlebytes.com/blog/2015/11/02/appledoc-contributors-needed/ - if you'd like to contribute to next major version, let me know and I can add you to the team!