https://github.com/serhii-londar/DocumenterXcode

Attempt to give a new life for VVDocumenter-Xcode as source editor extension.
https://github.com/serhii-londar/DocumenterXcode

hacktoberfest objective-c vvdocumenter xcode xcode-extension xcode-plugin xcode8 xcode9

Last synced: about 1 month ago
JSON representation

Attempt to give a new life for VVDocumenter-Xcode as source editor extension.

• Host: GitHub
• URL: https://github.com/serhii-londar/DocumenterXcode
• Owner: serhii-londar
• Created: 2017-12-19T23:39:00.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-10-12T17:29:26.000Z (almost 6 years ago)
• Last Synced: 2024-04-24T19:26:32.760Z (5 months ago)
• Topics: hacktoberfest, objective-c, vvdocumenter, xcode, xcode-extension, xcode-plugin, xcode8, xcode9
• Language: Objective-C
• Homepage:
• Size: 23.2 MB
• Stars: 36
• Watchers: 4
• Forks: 13
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-xcode-extensions - DocumenterXcode - Xcode source editor extension which helps you write documentation comment easier, for both Objective-C and Swift. (The list / Typed Boilerplate Code Generators)
• awesome-ios - DocumenterXcode - Attempt to give a new life for VVDocumenter-Xcode as source editor extension. (Xcode / Extensions)
• awesome-ios-star - DocumenterXcode - Attempt to give a new life for VVDocumenter-Xcode as source editor extension. (Xcode / Extensions)

README

        
# 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](https://github.com/onevcat/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](https://github.com/serhii-londar/DocumenterXcode/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.