| commit | db5aec22b7d6c7c692b369e4372079943377ed5c | [log] [tgz] |
|---|---|---|
| author | cushon <cushon@google.com> | Wed Jul 20 10:46:40 2016 -0700 |
| committer | Liam Miller-Cushon <cushon@google.com> | Thu Jul 21 14:23:59 2016 -0700 |
| tree | d443203f795a7848d645e4c98410c6fb954e2afb | |
| parent | ba6bd8c12d63f60450fcc6ec41acb0d2e63acb64 [diff] |
Handle <code> tags These tags currently receive no special handling, which causes line breaks inside multi-line <code> blocks to be lost. The blocks need to be wrapped in <pre>s to render correctly, but the formatter should still avoid mangling whitespace. Also, only recognize 'footer' javadoc tags that start with a lowercase letter. This includes all supported javadoc tags, and excludes unescaped annotations inside code blocks (which are currently formatted as if they were tags). MOE_MIGRATED_REVID=127962506
google-java-format is a program that reformats Java source code to comply with Google Java Style.
Download the formatter and run it with:
java -jar /path/to/google-java-format-1.0-all-deps.jar <options> [files...]
The formatter can act on whole files, on limited lines (--lines), on specific ofsets (--offset), passing through to standard-out (default) or altered in-place (--replace).
To reformat changed lines in a specific patch, use [google-java-format-diff.py] (https://github.com/google/google-java-format/blob/master/scripts/google-java-format-diff.py)
Note: There is no configurability as to the formatter's algorithm for formatting. This is a deliberate design decision to unify our code formatting on a single format.
The formatter can be used in software which generates java to output more legible java code. Just include the library in your maven/gradle/etc. configuration.
<dependency> <groupId>com.google.googlejavaformat</groupId> <artifactId>google-java-format</artifactId> <version>1.0</version> </dependency>
dependencies { compile 'com.google.googlejavaformat:google-java-format:1.0' }
You can then use the formatter through the formatSource methods. E.g.
String formattedSource = new Formatter().formatSource(sourceString);
or
CharSource source = ... CharSink output = ... new Formatter().formatSource(source, output);
Your starting point should be the instance methods of com.google.googlejavaformat.java.Formatter.
mvn install
Please see the contributors guide for details.
Copyright 2015 Google Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.