Document Objective-C++ #187

Closed
victor opened this Issue Feb 23, 2012 · 1 comment

2 participants

@victor

I'm working on a huge codebase consisting of mixed Objective-C, Objective-C++ and C++.
While appledoc can document the Objective-C and Objective-C++ methods, it doesn't even look at the C++ and Objective-C++ functions
I'd prefer to use a single tool for documenting, specially since being new in the company I'm not familiar with all the classes and having docs inside Xcode would be a great help.
I'd understand if you don't want to follow that path, so I'd appreciate a few hints on where to start implementing it myself.

TIA
victor

@tomaz
Owner

Not at the moment - some work on this has already be done by Martin Pilkington, you can pick up where he left it, see #2 for details. What you'd need to implement is:

  1. Parsing C/C++ data into GBStore
  2. Processing comments (you can reuse existing code, just add missing structures)
  3. Generate output - you'll probably need new template or you can use existing one.

I'd recommend you reuse existing model layer classes as much as possible, then you can also reuse much of the processing and generating code that relies on them. It's not that complicated, but it's quite a bit of work, which is the only reason I didn't start it - my time currently doesn't permit it. If you get stuck, feel free to contact me on email (see readme file)!

I'm closing this ticket as it's duplicate of #2 - add your further comments there, so it all stays under the same roof :)

@tomaz tomaz closed this Feb 23, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment