aboutsummaryrefslogtreecommitdiffhomepage
path: root/examples
diff options
context:
space:
mode:
authorGravatar Dave MacLachlan <dmaclach@google.com>2016-02-03 22:29:27 +0000
committerGravatar David Chen <dzc@google.com>2016-02-04 18:10:45 +0000
commit2f4d1c2583b3fc1ce63d7c5eb678f0717c21db1a (patch)
treebdd6080fa0c89e78329876ccd38fed2636f96fc6 /examples
parent84a0f8c7b56890a6f892c13dcb736805de5a401c (diff)
Get rid of some g3doc warnings.
-- MOS_MIGRATED_REVID=113782855
Diffstat (limited to 'examples')
-rw-r--r--examples/cpp/README.md3
-rw-r--r--examples/j2objc/README.md12
-rw-r--r--examples/java-native/README.md3
-rw-r--r--examples/java-skylark/README.md3
-rw-r--r--examples/objc/README.md3
5 files changed, 10 insertions, 14 deletions
diff --git a/examples/cpp/README.md b/examples/cpp/README.md
index fba714321c..64d8a06b49 100644
--- a/examples/cpp/README.md
+++ b/examples/cpp/README.md
@@ -1,4 +1,3 @@
-C++ Examples
-============
+# C++ Examples
These examples demonstrate building C++ binaries, libraries, and tests.
diff --git a/examples/j2objc/README.md b/examples/j2objc/README.md
index f30a52348a..40a5157f68 100644
--- a/examples/j2objc/README.md
+++ b/examples/j2objc/README.md
@@ -1,11 +1,11 @@
-J2ObjC Examples
-======
+# J2ObjC Examples
J2ObjC is an open-source tool that can transpile Java code to Objective-C code,
-which can then be used by dependent Objective-C code. The J2ObjC repository can be found at
-<https://github.com/google/j2objc>.
+which can then be used by dependent Objective-C code. The J2ObjC repository can
+be found at <https://github.com/google/j2objc>.
-The example in this directory shows a simple use of J2Objc with a Java library and an iOS app.
+The example in this directory shows a simple use of J2Objc with a Java library
+and an iOS app.
Because it builds an iOS application it can only be run on Mac OSX.
Here, a java_library is transpiled to Objective-C via j2objc_library.
We can then have an objc_library call upon this library.
@@ -14,4 +14,4 @@ Build the top-level application with
`bazel build examples/j2objc:J2ObjcExample`, which when finished emits the
path to a generated .ipa which you can then install to your test device. The
same build will also emits the path to an Xcode project directory which you can
-open to continue working with the application in Xcode. \ No newline at end of file
+open to continue working with the application in Xcode.
diff --git a/examples/java-native/README.md b/examples/java-native/README.md
index fb37462bf3..fbda6d320f 100644
--- a/examples/java-native/README.md
+++ b/examples/java-native/README.md
@@ -1,4 +1,3 @@
-Java Examples
-=============
+# Java Examples
This directory contains examples for Java language rules.
diff --git a/examples/java-skylark/README.md b/examples/java-skylark/README.md
index b50c8ec677..8a3eea18b2 100644
--- a/examples/java-skylark/README.md
+++ b/examples/java-skylark/README.md
@@ -1,5 +1,4 @@
-Skylark Java Examples
-=====================
+# Skylark Java Examples
Use the native Java rules (see the examples in _examples/java-native_) for
building Java, not these. These files are examples of how Skylark rules can be
diff --git a/examples/objc/README.md b/examples/objc/README.md
index 552c5706ae..a8769bf156 100644
--- a/examples/objc/README.md
+++ b/examples/objc/README.md
@@ -1,5 +1,4 @@
-Objective C Examples
-======
+# Objective C Examples
The example in this directory show typical use of Objective C libraries,
binaries and imports. Because they build an iOS application they can only be run