titan_executor_api/TITAN_Executor_API/readme.txt

   1 ###############################################################################
   2 # Copyright (c) 2000-2016 Ericsson Telecom AB
   3 # All rights reserved. This program and the accompanying materials
   4 # are made available under the terms of the Eclipse Public License v1.0
   5 # which accompanies this distribution, and is available at
   6 # http://www.eclipse.org/legal/epl-v10.html
   7 ###############################################################################
   8 Javadoc can be generated with this command:
   9 ant -f javadoc.xml
  10
  11 build.xml and javadoc.xml are generated from Eclipse.
  12 The generated build.xml is modified manually: eclipse dependent targets were removed.
  13
  14 Steps to generate build.xml from Eclipse:
  15   1. Right click on TITAN_Executor_API -> Export...
  16   2. Select General/Ant Buildfiles
  17
  18 Steps to generate javadoc.xml from Eclipse:
  19   1. Right click on TITAN_Executor_API -> Export...
  20   2. Select Java/Javadoc
  21   3. Next
  22   4. Make sure, that "Javadoc command" field contains a javadoc executable from a JDK.
  23       If a JDK is set in Window/Preferences/Java/Installed JREs as a JRE, this field is automatically filled,
  24       otherwise a javadoc executable must be selected manually.
  25   5. Select "Use standard doclet" (default) -> <workspace>/TITAN_Executor_API/doc (default)
  26   6. Next
  27   7. Switch on "Document title", type "TITAN Executor API Javadoc"
  28   8. Next
  29   9. Switch on "Overview" -> <workspace>/TITAN_Executor_API/doc/javadoc-overview/javadoc-overview.html
  30  10. Switch on "Save the settings of this Javadoc export as an Ant script" -> <workspace>/TITAN_Executor_API/javadoc.xml (default)
  31  11. Finish
  32