在eclipse中制作API参考文档

最新推荐文章于 2024-10-15 15:21:58 发布
最新推荐文章于 2024-10-15 15:21:58 发布
阅读量108 收藏
点赞数
分类专栏： eclipse杂项 文章标签： eclipse
具体可参考IBM的文章：[url]http://www.ibm.com/developerworks/cn/rational/07/0320_alupului/[/url]。

谈一下遇到的问题，首先是从工程里导出API的html文档，本次导出涉及133个插件工程，内存占用量高达630M，全部导完花去10-20分钟。
导出设置时注意以下配置：
[img]http://dl.iteye.com/upload/attachment/0063/2247/a6a2ab55-8cb5-3081-b90b-4663af25032b.jpg[/img]
分配内存最大值设为1024M，编码方式设为utf-8。

导完后，需要划分Topic，将这些Topic链接到API参考文档里，便于分工协作。所有的TOC文件都必须在plugin.xml里注册。为了避免手工进行Topic划分和Topic下的package注册，使用以下程序自动生成相关TOC文件并完成在plugin.xml里的注册和API参考文档里的link。 

package org.autumn.doc.user.generate;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.List;

import org.autumn.doc.user.Activator;

/**
 * 1 - topics目录下生成TOC文件 <br/>
 * 2 - plugin.xml里注册TOC文件 <br/>
 * 3 - topics_Reference.xml里注册TOC文件
 * 
 * @author sunny
 * 
 */
public class GeneratePluginToc {
	public static final String DOC_DIR = "doc";
	public static final String TOPICS_DIR = "topics";
	public static final String WS_DIR = "E:\\Autumn BPM\\ws4bpm";
	public static final String TOPICS_FILE_EXTENSION = ".toc.xml";
	public static final String PLUGIN_XML = "plugin.xml";
	public static final String SUMMARY_HTML = "package-summary.html";
	public static final String TOPICS_REFERENCE_XML = "topics_Reference.xml";
	public static final String SEPRATOR = System.getProperty("file.separator");
	public static final String DOT = ".";

	private static List<String> plugins = new ArrayList<String>();
	static {
		plugins.add("org.autumn.action.core");
		plugins.add("org.autumn.action.interceptor.navigator");
		plugins.add("org.autumn.action.interceptor.spec");
		plugins.add("org.autumn.action.layout");
		plugins.add("org.autumn.action.model");
		plugins.add("org.autumn.ado.core");
		plugins.add("org.autumn.ado.spec");
		plugins.add("org.autumn.bpm.behavior");
		plugins.add("org.autumn.bpm.client");
		plugins.add("org.autumn.bpm.commons");
		plugins.add("org.autumn.bpm.core");
		plugins.add("org.autumn.bpm.data");
		plugins.add("org.autumn.bpm.engine");
		plugins.add("org.autumn.bpm.event.register");
		plugins.add("org.autumn.bpm.event.thrower");
		plugins.add("org.autumn.bpm.event.trigger");
		plugins.add("org.autumn.bpm.loadbalance");
		plugins.add("org.autumn.bpm.resource.service");
		plugins.add("org.autumn.bpm.runtime");
		plugins.add("org.autumn.builder");
		plugins.add("org.autumn.cluster");
		plugins.add("org.autumn.common.constraint");
		plugins.add("org.autumn.configuration.bpm");
		plugins.add("org.autumn.configuration.scheduler");
		plugins.add("org.autumn.core");
		plugins.add("org.autumn.database");
		plugins.add("org.autumn.entity");
		plugins.add("org.autumn.evaluation");
		plugins.add("org.autumn.expression.core");
		plugins.add("org.autumn.expression.defs");
		plugins.add("org.autumn.expression.expand");
		plugins.add("org.autumn.expression.json.factory");
		plugins.add("org.autumn.expression.json.render");
		plugins.add("org.autumn.expression.sql.factory");
		plugins.add("org.autumn.expression.sql.render");
		plugins.add("org.autumn.form.service");
		plugins.add("org.autumn.identity");
		plugins.add("org.autumn.logicview.core");
		plugins.add("org.autumn.logicview.expand");
		plugins.add("org.autumn.logicview.model");
		plugins.add("org.autumn.model.core");
		plugins.add("org.autumn.model.data");
		plugins.add("org.autumn.model.defs");
		plugins.add("org.autumn.model.editdomain");
		plugins.add("org.autumn.model.extension");
		plugins.add("org.autumn.model.loader");
		plugins.add("org.autumn.model.navigator.core");
		plugins.add("org.autumn.operator");
		plugins.add("org.autumn.scheduler.core");
		plugins.add("org.autumn.scheduler.engine");
		plugins.add("org.autumn.scheduler.model");
		plugins.add("org.autumn.sdo");
		plugins.add("org.autumn.type");
		plugins.add("org.autumn.ui.decorator");
		plugins.add("org.autumn.view.data");
		plugins.add("org.autumn.view.feature");
		plugins.add("org.autumn.viewspec.core");
		plugins.add("org.autumn.viewspec.expand");
		plugins.add("org.autumn.viewspec.model");
	}

	private static void generateAll() {
		generateTocs();
		regeisterPluginXML();
		regeisterTopicsReferenceXML();
	}

	private static void generateTocs() {
		File topicsDir = new File(getProjectPath() + SEPRATOR + TOPICS_DIR);
		for (File topic : topicsDir.listFiles()) {
			topic.delete();
		}

		for (String plugin : plugins) {
			File toc = new File(topicsDir + SEPRATOR + plugin
					+ TOPICS_FILE_EXTENSION);
			if (!toc.exists()) {
				try {
					toc.createNewFile();
				} catch (IOException e) {
					e.printStackTrace();
				}
			}

			try {
				PrintWriter writer = new PrintWriter(toc);
				writer.println("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
				writer.printf("<toc label=\"%s\">%n", plugin);

				String docPath = getProjectPath() + SEPRATOR + DOC_DIR;
				File pluginDocDir = new File(docPath + SEPRATOR
						+ plugin.replaceAll("\\" + DOT, "/"));

				printTopicLine(writer, plugin, pluginDocDir);

				writer.println("</toc>");
				writer.close();
			} catch (FileNotFoundException e) {
				e.printStackTrace();
			}
		}
	}

	private static void printTopicLine(PrintWriter writer, String plugin,
			File dir) {
		List<String> files = new ArrayList<String>();
		for (File f : dir.listFiles()) {
			files.add(f.getName());
		}
		for (File f : dir.listFiles()) {
			if (files.contains(SUMMARY_HTML)) {
				String path = dir.getPath().replace("\\", "/");
				String uriLike = plugin.replace(DOT, "/");
				String label = path.substring(path.indexOf(uriLike));
				String href = DOC_DIR + "/" + label + "/" + SUMMARY_HTML;
				writer.printf("\t<topic href=\"%s\" label=\"%s\">%n", href,
						label.replaceAll("/", DOT));
				writer.println("\t</topic>");

				files.remove(SUMMARY_HTML);
			}

			if (f.isDirectory()) {
				printTopicLine(writer, plugin, f);
			}
		}
	}

	private static void regeisterTopicsReferenceXML() {
		File topicsReferenceXML = new File(getProjectPath() + SEPRATOR
				+ TOPICS_REFERENCE_XML);
		try {
			PrintWriter writer = new PrintWriter(topicsReferenceXML);
			writer.println("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
			writer.println("<?eclipse version=\"3.4\"?>");
			writer.println("<toc label=\"API文档\">");

			File topicsDir = new File(getProjectPath() + SEPRATOR + TOPICS_DIR);
			for (File file : topicsDir.listFiles()) {
				String plugin = file.getName().replace(TOPICS_FILE_EXTENSION,
						"");
				String href = DOC_DIR + "/" + plugin.replace(DOT, "/") + "/"
						+ SUMMARY_HTML;
				writer.printf("\t<topic href=\"%s\" label=\"%s\">%n", href,
						plugin);
				writer.printf("\t\t<link toc=\"%s\">%n", TOPICS_DIR + "/"
						+ file.getName());
				writer.println("\t\t</link>");
				writer.println("\t</topic>");
			}

			writer.println("</toc>");
			writer.close();
		} catch (FileNotFoundException e) {
			e.printStackTrace();
		}
	}

	private static void regeisterPluginXML() {
		File pluginXML = new File(getProjectPath() + SEPRATOR + PLUGIN_XML);
		try {
			PrintWriter writer = new PrintWriter(pluginXML);
			writer.println("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
			writer.println("<?eclipse version=\"3.4\"?>");
			writer.println("<plugin>");
			writer.println("\t<extension point=\"org.eclipse.help.toc\">");
			writer.println("\t\t<toc file=\"toc.xml\" primary=\"true\">");
			writer.println("\t\t</toc>");
			writer.println("\t\t<index path=\"index\">");
			writer.println("\t\t</index>");
			writer.println("\t</extension>");
			writer.println("\t<extension point=\"org.eclipse.help.toc\">");
			writer.println("\t\t<toc file=\"topics_Guide.xml\">");
			writer.println("\t\t</toc>");
			writer.println("\t</extension>");
			writer.println("\t<extension point=\"org.eclipse.help.toc\">");
			writer.printf("\t\t<toc file=\"%s\">%n", TOPICS_REFERENCE_XML);
			writer.println("\t\t</toc>");

			File topicsDir = new File(getProjectPath() + SEPRATOR + TOPICS_DIR);
			for (File file : topicsDir.listFiles()) {
				writer.printf("\t\t<toc file=\"%s\">%n", TOPICS_DIR + "/"
						+ file.getName());
				writer.println("\t\t</toc>");
			}

			writer.println("\t</extension>");
			writer.println("</plugin>");
			writer.close();
		} catch (FileNotFoundException e) {
			e.printStackTrace();
		}
	}

	private static String getProjectPath() {
		return WS_DIR + SEPRATOR + Activator.PLUGIN_ID;
	}

	public static void main(String[] args) {
		GeneratePluginToc.generateAll();
	}

}
cutesunshineriver
关注
专栏目录
Eclipse Plugin开发者API
01-23
eclipse plugin 开发者帮助api文档
Eclipse生成API
潜龙勿用
09-19 878
一、Project -&gt; Generate Javadoc  二、选择文件  三、选择 jre 版本，设置编码格式
Eclipse 制作API文档
Jameswwd的博客
12-22 506
eclipse 制作API文档 1.选择工程，在菜单Project->Genarate Javadoc  2.选择工程，鼠标右键菜单Export ，选择Java 下面的Javadoc ，点”next” 按钮  3.选择工程，在菜单File->Export ，选择Java 下面的Javadoc ，点”next” 按钮  然后，可以选择生成到Javadoc 文档中的内容( 一般选public
Eclipse插件开发
helloworldhellobbboy的专栏
02-25 3926
一，基础知识 1，Eclipse框架 OSGi是open services gateway initiative的简称。 OSGi是一种为嵌入式硬件开发的，是网络上的服务提供者和使用者交互的注册服务。 Eclipse从3.0使用OSGi来进行插件管理。 所以Eclipse就是一个插件管理平台，用户使用某个功能，实际上只是调用某个插件。 SWT和JFace插件
Eclipse Plugin开发
墙头草
11-26 169
好做，自己看Eclipse Plugin开发文档，或者按照Eclipse的向导逐步开发，大概简单的插件就那么几个小时
eclipse-collections-api-7.1.2.jar中文-英文对照文档.zip
03-08
中文-英文对照文档,中英对照文档,java,jar包,Maven,第三方jar包,组件,开源组件,第三方组件,Gradle,中文API文档,手册,开发手册,使用手册,参考手册 # 使用方法： 解压 【***.jar中文文档.zip】，再解压其中的 【***-...
org.eclipse.jgit-5.13.0.202109080827-r.jar中文-英文对照文档.zip
03-11
中文-英文对照文档,中英对照文档,java,jar包,Maven,第三方jar包,组件,开源组件,第三方组件,Gradle,中文API文档,手册,开发手册,使用手册,参考手册 # 使用方法： 解压 【***.jar中文文档.zip】，再解压其中的 【***-...
eclipse-collections-7.1.2.jar中文-英文对照文档.zip
03-08
中文-英文对照文档,中英对照文档,java,jar包,Maven,第三方jar包,组件,开源组件,第三方组件,Gradle,中文API文档,手册,开发手册,使用手册,参考手册 # 使用方法： 解压 【***.jar中文文档.zip】，再解压其中的 【***-...
org.eclipse.jgit-5.10.0.202012080955-r.jar中文-英文对照文档.zip
03-08
中文-英文对照文档,中英对照文档,java,jar包,Maven,第三方jar包,组件,开源组件,第三方组件,Gradle,中文API文档,手册,开发手册,使用手册,参考手册 # 使用方法： 解压 【***.jar中文文档.zip】，再解压其中的 【***-...
获取Android的Java源代码并在Eclipse中进行关联.doc
06-11
### 获取Android的Java源代码并在Eclipse中进行关联 #### 一、准备工作 为了能够顺利地获取Android的Java源代码并在Eclipse中进行关联，我们需要完成以下准备工作： 1. **下载并安装Android SDK**： - 访问[官方...
eclipse api_Eclipse中的API工具：简介
cuxiong8996的博客
07-03 2676
在详细介绍Eclipse插件开发环境（PDE）中的应用程序公共接口（API）工具之前，让我们先谈谈在Eclipse中成为API的含义。 什么是API？ 是否曾经在Eclipse中收到以下警告或错误，并想知道它们的含义？ 图1.阻止访问 内部包装 除了命名约定以外，在插件中真正使程序包成为API的真正原因是程序包是否在MANIFEST.MF文件中导出。 如果是，则将其视为A...
【Java】使用Eclipse生成API文档
编程记录，亲测有效
01-26 5815
据说某些公司需要员工们不仅要写好程序，而且要写好API，对于一些编程大神来说，写API是一件麻烦的事情， 其实Eclipse能够轻松地生成API来忽悠人，尤其是你讨厌的根本不会写代码的上司。 当然，这些API根本就不知道有什么用，还不如当面跟你的队友好好解释一下每一句是干什么的，还不如在你的Java文件中注释好每一句话。 1、对于你要生成的API的工程或者某个JAVA文件点右键，选择Expo
利用eclipse生成API文档
_happyzhang的专栏
06-02 4092
制作目的： 提供了很多官方的介绍和类、方法、变量的解释。由于我主要是做Android开发，还提供自己封装的一些公用方法和组件。如果开发人员对正在使用的类不熟悉，想查看类里面的变量或者方法，就可以打开JavaAPI文档进行阅读和查看。很多开发语言都提供了官方的文档，可以让开发人员迅速地提高能力。 生成方法： 1.打开Eclipse，点击工程，选择project - Generate Javad
eclipse java 生成api_怎样使用Eclipse在Java中实现自己的API
weixin_30673759的博客
02-13 1453
步骤1：创建项目1。首先打开Eclipse并浏览到当前工作空间。我将创建一个新的工作区，以便项目层次结构不会被项目所阻塞。2。进入Eclipse后，创建一个新的Java项目并为其命名。在确认名称之前，请注意，您要创建的项目是针对稍后将要实现的实际API的。3。创建项目后，请确保您可以在项目浏览器窗口中看到它。此步骤是确保您不会将任何其他项目与此当前项目混在一起。步骤2：创建程序包和类1。首先，在包...
eclipse中怎么生成API帮助文档
Jikicet
05-09 754
在eclipse中生成API帮助文档的三种方式：
Eclipse生成API文档
tianlong1569的专栏
03-10 1945
在Eclipse工具栏中选择“Project”，弹出下拉菜单，在下拉菜单中选择“Generate javadoc...”，弹出选择项目对话框，在对话框中选择要生成API的项目，并在“Use standard doclet”选项中选择要将生成的API文档存储到什么位置。选择“NEXT”菜单，进入下一个对话框，在对话框的“Document TItle”选择项中输入生成的API文档名称，选择NEXT,进
用Eclipse运行第一个Java程序
tystuxd的博客
10-15 671
注：如果出现报错，检查自己的单词是否拼写错误。
基于Matlab面板版的卡尔曼小球运动跟踪[Matlab面板版].zip
最新发布
10-16
大模型实战教程
Android开发入门指南：环境搭建与Eclipse集成
"Android编程指南，东软集团嵌入式软件事业部Android软件产品开发组制作，内容涵盖Android环境搭建、Eclipse与SDK集成、程序开发入门等" 本文档是一份全面的Android编程指南，旨在帮助初学者及开发者了解并掌握...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值