Giter Club home page Giter Club logo

documenterxcode's Introduction

DocumenterXcode

Xcode source editor extension which helps you write documentation comment easier, for both Objective-C and Swift.

This project is an attempt to give a new life for VVDocumenter-Xcode for Xcode as source editor extension.

This repository contains settings app and xcode source editor extension.

What is this?

Writing documentation is so important for developing, but it is really painful with Xcode. Starting from Xcode 9 apple added support for code documenting. This project is providing more flexible code documenting process. You can use various settings to write your documentation.

How to install and use:

Install

You can build it by your own, just checkout this repo, open DocumenterXcode.xcodeproj and press run.

Also you can Download app and extension from releases.

Do not forget to enable Documenter Xcode in Settings:

Usage

To create documentation fou your method you need to set cursor about this methot and execute extension using : Editor -> DocumenterXcodeExtension -> Comment.

TO DO

  • Fix issue with swift documenting.
  • Support swift 3.0 and more.
  • Rewrite to swift.

License

DocumenterXcode is published under MIT License. See the LICENSE file for more.

documenterxcode's People

Contributors

serhii-londar avatar

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.