View Javadoc
1   package org.apache.maven.doxia.module.markdown;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.doxia.parser.module.AbstractParserModule;
23  import org.apache.maven.doxia.parser.module.ParserModule;
24  import org.codehaus.plexus.component.annotations.Component;
25  
26  /**
27   * {@link org.apache.maven.doxia.parser.module.ParserModule} for Markdown.
28   *
29   * @since 1.6
30   */
31  @Component( role = ParserModule.class, hint = "markdown" )
32  public class MarkdownParserModule
33      extends AbstractParserModule
34  {
35      /**
36       * The extension for Markdown files.
37       */
38      public static final String FILE_EXTENSION = "md";
39  
40      /**
41       * Alternate extension for Markdown files.
42       */
43      public static final String ALTERNATE_FILE_EXTENSION = "markdown";
44  
45      /**
46       * Build a new instance of {@link MarkdownParserModule}.
47       */
48      public MarkdownParserModule()
49      {
50          super( MarkdownParser.ROLE_HINT, MarkdownParser.ROLE_HINT, FILE_EXTENSION, ALTERNATE_FILE_EXTENSION );
51      }
52  }