Comments (20)
+1
from jazzy.
This would imply support for C projects as well, wouldn't it?
from jazzy.
@beltex yes, since Objective-C is a strict superset of C.
from jazzy.
Cool, thanks @segiddins!
from jazzy.
@beltex I see the merged PR, so is this ready/working?
from jazzy.
@mattapperson @beltex much of the logic is already in sourcekitten, but we haven't started integrating it in jazzy yet. Trust me, we'll be sure to update this issue as soon as we have a working proof-of-concept.
from jazzy.
Where are we with this. What still needs to be done?
from jazzy.
Where are we with this. What still needs to be done?
Most of the work that needs to be done is in SourceKitten.
We have a proof-of-concept Objective-C header "parser" in SourceKitten (jazzy's "backend") which generates this. This is tested in SourceKitten. We need to transform this result into the same format as the Swift parsed results (eg. this). You're welcome to contribute to this if you'd like!
from jazzy.
Would it be possible for someone familiar with the project to generate (even if by hand) a "correct" version of Musician
to illustrate what actually needs to happen in the transformation? Or (possibly) better.. I would assume the swift code is also, at some point, getting json
-ified (from a similar xml
source as Musician
). Where is that work being done (already).. maybe looking at that will simply clear things up...
from jazzy.
I'm counting on this 👍
from jazzy.
@jcayzac there's a PR open over on SourceKitten
from jazzy.
@jcayzac jpsim/SourceKitten#57 builds & tests successfully with Xcode 7 beta 4. The Travis CI builds fail since its latest supported Xcode version is 6.4.
from jazzy.
@jpsim that's great to know! Thanks! 👍
from jazzy.
Progress update, there's still more cleanup to do in jpsim/SourceKitten#57 until we can officially ship Objective-C support with Jazzy, but I'm hoping to have that done by the end of this week.
Thanks for your patience.
from jazzy.
👍 !
from jazzy.
👏
from jazzy.
Jazzy supports Objective-C projects as of 0.4.0! 🎉 https://github.com/realm/jazzy/releases/tag/v0.4.0
from jazzy.
@jpsim awesome, thanks!
Since it's one of the project's stated goals, would it be possible to get one step closer to Apple's documentation by generating mixed ObjC/Swift documentation from ObjC code?
from jazzy.
We're tracking those as #136 and #353 with a proof of concept at jpsim/SourceKitten#95
from jazzy.
@jpsim wow, great, thanks!
from jazzy.
Related Issues (20)
- Objc XCFramework - jazzy failed with error: 'MyModule/Myfile.h' file not found HOT 2
- Latest Jazzy verson is not generating the link to html file correctly HOT 4
- [iOS Xcode] Unable to generate documentation for module header files (.h) defined in bridging header for ObjectiveC and swift mixed project. HOT 6
- Sections Parameters, Declaration and Return Value not generated HOT 3
- Search option is not working. HOT 1
- The installation of jazzy through gem does not work (OSX 13.4.1 / XCode 14.3.1) HOT 2
- How does Jazzy keep track of what percent of documentation is completed? HOT 4
- How does Jazzy keep track of what percent of documentation is completed? HOT 1
- Many errors reported on valid source HOT 2
- Jazzy chokes on target names containing '-' HOT 2
- Xcode 15: Unknown symbol kind swift.extension HOT 4
- Runtime error in running jazzy: undefined method `deprecator' for ActiveSupport:Module (NoMethodError) HOT 3
- zsh: no matches found: --documentation=./*.md HOT 1
- iOS only SPM won't build HOT 2
- Missing docs with @available(iOSApplicationExtension, unavailable) and APPLICATION_EXTENSION_API_ONLY = YES HOT 4
- Can't exclude files generated during build. HOT 2
- Error generating documentation: Could not find SPM module HOT 3
- Type alias link generation is not working properly in M1 HOT 2
- No parameters listed for `init` methods from symbolgraph. HOT 2
- Cannot Execute Jazzy that's installed using Bundler on XCode 15.2 HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from jazzy.