Comments (4)
Currently, documentation is generated for only public declarations (public
or open
modifiers). Assuming that you aren't embedding dependencies alongside your source files, I would recommend specifying a more specific path to exclude vendored code.
from swift-doc.
so i can not document the wole project ? if i want to document the whole project i will make standalone documentation for each class!? although i tried specifying a more specific path to exclude vendored code and did not find any thing in documentation folder , it is empty
from swift-doc.
You can indeed generate documentation for your whole project all at once; my point was that you'd probably want to limit to your own code, and not 3rd party dependencies (e.g. nothing in the Pods
directory).
If documentation for your own classes aren't showing up, it's most likely because they aren't declared with public
or open
modifiers. By default, declarations have an implicit internal
access level, and those aren't currently emitted by swift-doc
.
For example, if you have a view controller, like:
/// Documentation for MyViewController
class MyViewController: UIViewController { ... }
You should make add a public
access modifier:
/// Documentation for MyViewController
public class MyViewController: UIViewController { ... }
from swift-doc.
This feature is tracked by #72.
from swift-doc.
Related Issues (20)
- Operators are not included in the generated documentation if there are multiple operators with the same name
- Add designs to accommodate all types of callout in discussion in HTML output HOT 1
- Add section to README for troubleshooting installation HOT 1
- Character substitution in file names can lead to collisions HOT 1
- Localize generated output HOT 1
- Migrate from Docker Hub to GitHub Container Registry HOT 1
- Improve estimation of diagram boxes
- Feature Request: support x-source-tag
- Loud GitHub diffs
- Feature Idea: HTML folders based on project folders HOT 1
- Comment tags are not recognized HOT 3
- Generate Diagram in Swift-doc
- Documentation links to non-existent internal protocols HOT 2
- Group management
- `Error: The loaded '_InternalSwiftSyntaxParser' library is from a toolchain that is not compatible with this version of SwiftSyntax` HOT 2
- Support for local html file browsing
- Feature request: Declarations with a documentation comment containing `:nodoc:` are excluded from the documentation.
- Error to load CSS in Index.html [Fix] [CSS] HOT 2
- Displaying documentation coverage with GitHub Action?
- Documentation coverage report
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 swift-doc.