View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2026 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ///////////////////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle.site;
21  
22  import java.nio.file.Path;
23  
24  import org.apache.maven.doxia.macro.AbstractMacro;
25  import org.apache.maven.doxia.macro.Macro;
26  import org.apache.maven.doxia.macro.MacroExecutionException;
27  import org.apache.maven.doxia.macro.MacroRequest;
28  import org.apache.maven.doxia.sink.Sink;
29  import org.codehaus.plexus.component.annotations.Component;
30  
31  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
32  
33  /**
34   * A macro that inserts a notes subsection of module from its Javadoc.
35   */
36  @Component(role = Macro.class, hint = "notes")
37  public class NotesMacro extends AbstractMacro {
38  
39      @Override
40      public void execute(Sink sink, MacroRequest request) throws MacroExecutionException {
41          final Path modulePath = Path.of((String) request.getParameter("modulePath"));
42          final String moduleName = CommonUtil.getFileNameWithoutExtension(modulePath.toString());
43  
44          SiteUtil.processModule(moduleName, modulePath);
45          final String moduleNotes = JavadocScraperResultUtil.getModuleNotes();
46  
47          ModuleJavadocParsingUtil.writeOutJavadocPortion(moduleNotes, sink);
48  
49      }
50  
51  }