Skip to content

Commit

Permalink
Add script for generating ojbc doc for Flutter iOS libraries (flutter…
Browse files Browse the repository at this point in the history
  • Loading branch information
szakarias authored Jun 21, 2017
1 parent f61869e commit a08f52e
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions tools/gen_objcdoc.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
#!/usr/bin/env bash
# Copyright 2017 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

# Generates objc docs for Flutter iOS libraries.

if [ ! -d "shell/platform/darwin/ios" ]
then
echo "Error: This script must be run at the root of the Flutter source tree."
exit 1
fi

if [ $# -eq 0 ]
then
echo "Error: Argument specifying output directory required."
exit 1
fi

jazzy \
--objc\
--clean\
--author Flutter Team\
--author_url 'https://flutter.io'\
--github_url 'https://github.com/flutter'\
--github-file-prefix 'http://github.com/flutter/engine/blob/master'\
--module-version 1.0.0\
--xcodebuild-arguments --objc,shell/platform/darwin/ios/framework/Headers/Flutter.h,--,-x,objective-c,-isysroot,$(xcrun --show-sdk-path),-I,$(pwd)\
--module Flutter\
--root-url https://docs.flutter.io/objc/\
--output $1\
--no-download-badge

0 comments on commit a08f52e

Please sign in to comment.