Giter Club home page Giter Club logo

Comments (4)

mattt avatar mattt commented on June 18, 2024 1

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.

khaledbohout2 avatar khaledbohout2 commented on June 18, 2024

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.

mattt avatar mattt commented on June 18, 2024

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.

mattt avatar mattt commented on June 18, 2024

This feature is tracked by #72.

from swift-doc.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.