Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
FormulaMacroConfiguration	35	0	-	0	0	-1.0 -	Show methods

Class FormulaMacroConfiguration

Class FormulaMacroConfiguration	Line # 35	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing 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.macro.formula;
21
22		import org.xwiki.component.annotation.Role;
23
24		/**
25		* Configuration properties for the {@link org.xwiki.rendering.internal.macro.formula.FormulaMacro formula macro}.
26		* <p>
27		* You can override the default values for each of the configuration properties below by defining them in XWiki's global
28		* configuration file using a prefix of "macro.formula" followed by the property name. For example:
29		* <code>macro.formula.renderer = mathtran</code>
30		*
31		* @version $Id: b607ac5f2859c2ec17ff8022601e4f3bf9ebf871 $
32		* @since 2.0M3
33		*/
34		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
35		public interface FormulaMacroConfiguration
36		{
37		/**
38		* The hint of the {@link org.xwiki.formula.FormulaRenderer} component implementation to use for rendering math
39		* expressions into images.
40		*
41		* @return the configured hint, for example {@code "native"} or {@code "snuggletex"}
42		*/
43		String getRenderer();
44
45		/**
46		* The hint of {@link org.xwiki.formula.FormulaRenderer} component implementation that is considered to be "safe",
47		* meaning that it should always be available and always work, even if the quality of the resulting image is not the
48		* best.
49		*
50		* @return the hint of the "safe" renderer
51		*/
52		String getSafeRenderer();
53		}