Comments (5)
Very interesting find. How are you parsing the resulting binary?
from jazzy.
@jpsim I just ran vi on it and skimmed for recognizable strings in the soup of binary. My guess is there's additional info about the types added automatically. I haven't had time to dig into trying to reverse the binary format. It's likely Xcode knows how to parse it already, so pointing Hopper at Xcode would be another route for getting hints into the swiftdoc binary structure.
from jazzy.
Ah yes, popped it into a hex editor. Looks like it contains mostly what we already have by running xcrun swift-ide-test -print-comments
. Here's a gist showing the structured XML output we get from that.
It would still be useful to support generating docs for pre-compiled .swiftdoc files. So I'll keep this issue open, but that won't be a high priority just yet. Focusing on generating docs from source code first.
from jazzy.
reST indeed. From the Xcode release notes:
"Swift recognizes comments that start with the special marker /** or /// as documentation comments. Swift uses reStructuredText, an easy-to-read, modern lightweight markup language in documentation comments. Currently only block-level markup is supported (nested bullet and enumerated lists, field lists). In order to document function and method parameters, use :param: followed by parameter name, and to document return values use :returns:"
Also see - http://nshipster.com/swift-documentation/
from jazzy.
I looked into the .swiftdoc format, and unfortunately it doesn't have enough information to build comprehensive docs, so I'm closing this for now. We can re-open if Apple adds more information in this file.
from jazzy.
Related Issues (20)
- 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
- Is it possible to run jazzy as a phase of XCode Build Phases? HOT 3
- `block in next_doc_module_group': undefined local variable or method `_1' for Jazzy::SourceKitten:Module (NameError) HOT 4
- Loading sourcekitdInProc.framework/Versions/A/sourcekitdInProc failed HOT 2
- [Request] Patch release to unblock Ruby 2.6 compatibility HOT 2
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.