1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.rendering.internal.macro.comment

File CommentMacro.java

 

Coverage histogram

../../../../../../img/srcFileCovDistChart10.png
0% of files have more coverage

Code metrics

0
4
3
1
78
36
3
0.75
1.33
3
1

Classes

Class Line # Actions
CommentMacro 44 4 0% 3 0
1.0100%
 

Contributing tests

This file is covered by 2 tests. .

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software 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 software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.rendering.internal.macro.comment;
21   
22    import java.util.Collections;
23    import java.util.List;
24   
25    import javax.inject.Named;
26    import javax.inject.Singleton;
27   
28    import org.xwiki.component.annotation.Component;
29    import org.xwiki.rendering.block.Block;
30    import org.xwiki.rendering.macro.AbstractNoParameterMacro;
31    import org.xwiki.rendering.macro.MacroExecutionException;
32    import org.xwiki.rendering.macro.descriptor.DefaultContentDescriptor;
33    import org.xwiki.rendering.transformation.MacroTransformationContext;
34   
35    /**
36    * Allows putting comments in the source content. This macro doesn't output anything.
37    *
38    * @version $Id: 4b001d6f5ba41eab28b0880fe68a4d6eec45875d $
39    * @since 3.2M3
40    */
41    @Component
42    @Named("comment")
43    @Singleton
 
44    public class CommentMacro extends AbstractNoParameterMacro
45    {
46    /**
47    * The description of the macro.
48    */
49    private static final String DESCRIPTION =
50    "Allows putting comments in the source content. This macro doesn't output anything.";
51   
52    /**
53    * The description of the macro content.
54    */
55    private static final String CONTENT_DESCRIPTION = "Comments";
56   
57    /**
58    * Create and initialize the descriptor of the macro.
59    */
 
60  2 toggle public CommentMacro()
61    {
62  2 super("Comment", DESCRIPTION, new DefaultContentDescriptor(CONTENT_DESCRIPTION));
63  2 setDefaultCategory(DEFAULT_CATEGORY_DEVELOPMENT);
64    }
65   
 
66  1 toggle @Override
67    public boolean supportsInlineMode()
68    {
69  1 return true;
70    }
71   
 
72  2 toggle @Override
73    public List<Block> execute(Object unusedParameters, String content, MacroTransformationContext context)
74    throws MacroExecutionException
75    {
76  2 return Collections.emptyList();
77    }
78    }