Java tutorial
/* * Copyright 2016 the original author or authors. * * 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. */ package capital.scalable.restdocs.misc; import static capital.scalable.restdocs.OperationAttributeHelper.determineLineBreak; import static capital.scalable.restdocs.OperationAttributeHelper.getHandlerMethod; import static capital.scalable.restdocs.OperationAttributeHelper.getJavadocReader; import static capital.scalable.restdocs.javadoc.JavadocUtil.convertFromJavadoc; import static capital.scalable.restdocs.SnippetRegistry.DESCRIPTION; import java.util.HashMap; import java.util.Map; import org.springframework.restdocs.operation.Operation; import org.springframework.restdocs.snippet.TemplatedSnippet; import org.springframework.web.method.HandlerMethod; public class DescriptionSnippet extends TemplatedSnippet { public DescriptionSnippet() { super(DESCRIPTION, null); } @Override protected Map<String, Object> createModel(Operation operation) { HandlerMethod handlerMethod = getHandlerMethod(operation); String methodComment; if (handlerMethod != null) { methodComment = getJavadocReader(operation).resolveMethodComment(handlerMethod.getBeanType(), handlerMethod.getMethod().getName()); } else { methodComment = ""; } methodComment = convertFromJavadoc(methodComment, determineLineBreak(operation)); Map<String, Object> model = new HashMap<>(); model.put("description", methodComment); return model; } }