01: /*
02: * This file is part of "SnipSnap Radeox Rendering Engine".
03: *
04: * Copyright (c) 2002 Stephan J. Schmidt, Matthias L. Jugel
05: * All Rights Reserved.
06: *
07: * Please visit http://radeox.org/ for updates and contact.
08: *
09: * --LICENSE NOTICE--
10: * Licensed under the Apache License, Version 2.0 (the "License");
11: * you may not use this file except in compliance with the License.
12: * You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * Unless required by applicable law or agreed to in writing, software
17: * distributed under the License is distributed on an "AS IS" BASIS,
18: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19: * See the License for the specific language governing permissions and
20: * limitations under the License.
21: * --LICENSE NOTICE--
22: */
23:
24: package org.radeox.macro;
25:
26: import java.io.IOException;
27: import java.io.Writer;
28:
29: import org.apache.commons.logging.Log;
30: import org.apache.commons.logging.LogFactory;
31: import org.radeox.api.macro.MacroParameter;
32: import org.radeox.macro.api.ApiDoc;
33:
34: /*
35: * Lists all known API documentation repositories and mappings @author stephan
36: * @team sonicteam
37: *
38: * @version $Id: ApiDocMacro.java 29159 2007-04-19 01:46:15Z ajpoland@iupui.edu $
39: */
40:
41: public class ApiDocMacro extends BaseLocaleMacro {
42: private static Log log = LogFactory.getLog(ApiDocMacro.class);
43:
44: private String[] paramDescription = {};
45:
46: public String[] getParamDescription() {
47: return paramDescription;
48: }
49:
50: public String getLocaleKey() {
51: return "macro.apidocs";
52: }
53:
54: public void execute(Writer writer, MacroParameter params)
55: throws IllegalArgumentException, IOException {
56: ApiDoc apiDoc = ApiDoc.getInstance();
57: apiDoc.appendTo(writer);
58: return;
59: }
60: }
|