• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2015 Google Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5  * in compliance with the License. You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software distributed under the License
10  * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11  * or implied. See the License for the specific language governing permissions and limitations under
12  * the License.
13  */
14 
15 package com.google.googlejavaformat;
16 
17 /**
18  * Rewrite comments. This interface is implemented by {@link
19  * com.google.googlejavaformat.java.JavaCommentsHelper JavaCommentsHelper}.
20  */
21 public interface CommentsHelper {
22   /**
23    * Try to rewrite comments, returning rewritten text.
24    *
25    * @param tok the comment's tok
26    * @param maxWidth the line length for the output
27    * @param column0 the current column
28    * @return the rewritten comment
29    */
rewrite(Input.Tok tok, int maxWidth, int column0)30   String rewrite(Input.Tok tok, int maxWidth, int column0);
31 }
32