index.rst

Documentation

Welcome to OCLint |release| documentation!

From Scratch

• Overview
• Getting Ready: Download | Building | Installation | Homebrew
• Tutorial
• Directions for Safe Use

Usage

• Manual: oclint | oclint-json-compilation-database | oclint-xcodebuild
• User guide of using OCLint with:
  • CMake
  • Bear
  • xctool
  • xcodebuild
  • xcpretty
  • Xcode IDE
  • Travis CI
  • Jenkins CI
• How-To:
  • Customize Rule Thresholds
  • Select OCLint Rules for Inspection
  • Pick Up the Right Reporter
  • Suppress OCLint Warnings
  • Preserve Configurations
  • Setup OCLint in MinGW Environment

OCLint Internals

• Core
• Metrics
• Rules: Rule Index
• Reporters

Development

• Preparation: System Requirements | Checking Out Code
• Getting Your Hands Dirty: Compiling and Testing Code | Writing Rules | Writing Reporters | Scaffolding
• Others: Open Projects | Coding Standards | Dogfooding

License

• Modified BSD License