From: <jom...@us...> - 2008-08-29 09:59:31
|
Revision: 1359 http://jason.svn.sourceforge.net/jason/?rev=1359&view=rev Author: jomifred Date: 2008-08-29 09:59:27 +0000 (Fri, 29 Aug 2008) Log Message: ----------- use doxygen apidoc Modified Paths: -------------- trunk/build.xml trunk/doc/index.html trunk/doc/jason.doxygen trunk/src/jason/functions/time.java trunk/src/jason/stdlib/time.java Added Paths: ----------- trunk/src/jason/stdlib/package.dox Removed Paths: ------------- trunk/src/jason/stdlib/package.html Modified: trunk/build.xml =================================================================== --- trunk/build.xml 2008-08-29 09:22:29 UTC (rev 1358) +++ trunk/build.xml 2008-08-29 09:59:27 UTC (rev 1359) @@ -259,6 +259,7 @@ </delete> <delete dir="${distDir}/bin/classes" /> <delete dir="${distDir}/doc/faq" /> + <delete dir="${distDir}/doc/api" /> <delete dir="${distDir}/doc/mini-tutorial/src" /> <tar compression="gzip" tarfile="${distFile}.tgz"> Modified: trunk/doc/index.html =================================================================== --- trunk/doc/index.html 2008-08-29 09:22:29 UTC (rev 1358) +++ trunk/doc/index.html 2008-08-29 09:59:27 UTC (rev 1359) @@ -17,8 +17,8 @@ <li><a href="faq.html">FAQ</a> (html)</li><br/> -<li><a href="api/jason/stdlib/package-summary.html#package_description">Stantard internal actions</a> (html)</li> -<li><a href="api/jason/functions/package-summary.html">Stantard arithmetic functions</a> (html)</li> +<li><a href="api-doxygen/html/namespacejason_1_1stdlib.html">Stantard internal actions</a> (html)</li> +<li><a href="api-doxygen/html/namespacejason_1_1functions.html">Stantard arithmetic functions</a> (html)</li> <li><a href="api-doxygen/html/index.html">API of all classes</a> (html)</li><br> Modified: trunk/doc/jason.doxygen =================================================================== --- trunk/doc/jason.doxygen 2008-08-29 09:22:29 UTC (rev 1358) +++ trunk/doc/jason.doxygen 2008-08-29 09:59:27 UTC (rev 1359) @@ -551,7 +551,7 @@ # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 -FILE_PATTERNS = *.java +FILE_PATTERNS = *.java *.dox # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. Modified: trunk/src/jason/functions/time.java =================================================================== --- trunk/src/jason/functions/time.java 2008-08-29 09:22:29 UTC (rev 1358) +++ trunk/src/jason/functions/time.java 2008-08-29 09:59:27 UTC (rev 1359) @@ -8,6 +8,8 @@ <p>Function: <b><code>system.time</code></b>: encapsulates java System.currentTimeMillis(), returns the current time in milliseconds. + @see jason.stdlib.time + @author Jomi */ public class time extends DefaultArithFunction { Added: trunk/src/jason/stdlib/package.dox =================================================================== --- trunk/src/jason/stdlib/package.dox (rev 0) +++ trunk/src/jason/stdlib/package.dox 2008-08-29 09:59:27 UTC (rev 1359) @@ -0,0 +1,127 @@ +/*! @package jason.stdlib + +Provides all default internal actions of Jason. + +<h2>BDI</h2> +<ul> + <li>{@link jason.stdlib.desire desire}: check agent's desires.</li> + <li>{@link jason.stdlib.drop_desire drop_desire}: remove one agent's desire.</li> + <li>{@link jason.stdlib.drop_all_desires drop_all_desires}: remove agent's desires.</li> + + + <li>{@link jason.stdlib.intend intend}: check agent's intentions.</li> + <li>{@link jason.stdlib.drop_intention drop_intention}: remove one agent's intention.</li> + <li>{@link jason.stdlib.drop_all_intentions drop_all_intentions}: remove agent's intentions.</li> + <li>{@link jason.stdlib.current_intention current_intention}: get a description of the + current intention.</li> + + <li>{@link jason.stdlib.drop_event drop_event}: remove one event.</li> + <li>{@link jason.stdlib.drop_all_events drop_all_events}: remove events in the interpreter.</li> + + <li>{@link jason.stdlib.succeed_goal succeed_goal}: abort some goal with success.</li> + <li>{@link jason.stdlib.fail_goal fail_goal}: abort some goal with failure.</li> + + <li>{@link jason.stdlib.suspend suspend}: suspend intentions.</li> + <li>{@link jason.stdlib.resume resume}: resume suspended intentions.</li> +</ul> + +<h2>Belief base</h2> +<ul> + <li>{@link jason.stdlib.abolish abolish}: remove some beliefs.</li> + <li>{@link jason.stdlib.findall findall}: find all beliefs of some kind.</li> + <li>{@link jason.stdlib.count count}: count the number of beliefs of some kind.</li> +</ul> + + +<h2>Plan Library</h2> +<ul> + <li>{@link jason.stdlib.add_plan add_plan}: add new plans.</li> + <li>{@link jason.stdlib.remove_plan remove_plan}: remove a plan.</li> + <li>{@link jason.stdlib.plan_label plan_label}: get the label of a plan.</li> + <li>{@link jason.stdlib.relevant_plans relevant_plans}: get a list of plans.</li> +</ul> + + + +<h2>Communication</h2> +<ul> + <li>{@link jason.stdlib.send send}: send messages. </li> + <li>{@link jason.stdlib.broadcast broadcast}: broadcast messages.</li> + <li>{@link jason.stdlib.my_name my_name}: get the agent's name.</li> +</ul> + + +<h2>Lists and Sets</h2> +<ul> + <li>{@link jason.stdlib.member member}: list members. </li> + <li>{@link jason.stdlib.length length}: size of lists. </li> + + <li>{@link jason.stdlib.concat concat}: concat lists. </li> + <li>{@link jason.stdlib.delete delete}: delete members of a lists. </li> + + <li>{@link jason.stdlib.reverse reverse}: reverse lists. </li> + <li>{@link jason.stdlib.nth nth}: nth element of a lists. </li> + <li>{@link jason.stdlib.max max}: maximum value of a lists. </li> + <li>{@link jason.stdlib.min min}: minimum value of a lists. </li> + <li>{@link jason.stdlib.sort sort}: sort lists. </li> + <li>{@link jason.stdlib.list list}: check whether an argument is a list.</li> + + <li>{@link jason.stdlib.difference difference}: difference of sets. </li> + <li>{@link jason.stdlib.intersection intersection}: intersection of sets. </li> + <li>{@link jason.stdlib.union union}: union of sets. </li> + +</ul> + + +<h2>String</h2> +<ul> + <li>{@link jason.stdlib.length length}: size of strings. </li> + <li>{@link jason.stdlib.concat concat}: append strings. </li> + <li>{@link jason.stdlib.delete delete}: delete characters of a string. </li> + <li>{@link jason.stdlib.reverse reverse}: reverse strings. </li> + <li>{@link jason.stdlib.substring substring}: test substrings of strings. </li> + <li>{@link jason.stdlib.string string}: check whether an argument is a string.</li> + <li>{@link jason.stdlib.term2string term2string}: convert terms to strings and vice-versa.</li> +</ul> + +<h2>Execution control</h2> +<ul> + <li>{@link jason.stdlib.conditional if}: implementation of <b>if</b>.</li> + <li>{@link jason.stdlib.loop while}: implementation of <b>while</b>.</li> + <li>{@link jason.stdlib.foreach for}: implementation of <b>for</b>.</li> +</ul> + + +<h2>Meta programming</h2> +<ul> + <li>{@link jason.stdlib.atom atom}: check whether an argument is an atom (p).</li> + <li>{@link jason.stdlib.structure structure}: check whether an argument is a structure (p(t1,t2), [a,b]).</li> + <li>{@link jason.stdlib.literal literal}: check whether an argument is a literal (p(t1,t2), ~p(t1,t2), p(t1,t2)[a1,a2]).</li> + <li>{@link jason.stdlib.list list}: check whether an argument is a list ([a,b]).</li> + <li>{@link jason.stdlib.ground ground}: check whether an argument is ground.</li> + <li>{@link jason.stdlib.number number}: check whether an argument is a number (1, 2.3).</li> + <li>{@link jason.stdlib.string string}: check whether an argument is a string ("s").</li> + <li>{@link jason.stdlib.ground ground}: check whether an argument is ground.</li> + <li>{@link jason.stdlib.add_annot add_annot}: add an annotation in a literal.</li> + <li>{@link jason.stdlib.add_nested_source add_nested_source}: add a source in a literal.</li> +</ul> + + +<h2>Miscellaneous</h2> +<ul> + <li>{@link jason.stdlib.at at}: add a future event.</li> + <li>{@link jason.stdlib.wait wait}: wait some event.</li> + + <li>{@link jason.stdlib.create_agent create_agent}: create a new agent.</li> + <li>{@link jason.stdlib.kill_agent kill_agent}: kill an agent.</li> + <li>{@link jason.stdlib.stopMAS stopMAS}: stop all agents.</li> + + <li>{@link jason.stdlib.date date}: get the current date.</li> + <li>{@link jason.stdlib.time time}: get the current time.</li> + <li>{@link jason.stdlib.fail fail}: an action that always fails.</li> + <li>{@link jason.stdlib.perceive perceive}: force perception.</li> + <li>{@link jason.stdlib.range range}: backtrack values in a range (used in <b>for</b>).</li> +</ul> + +*/ + Deleted: trunk/src/jason/stdlib/package.html =================================================================== --- trunk/src/jason/stdlib/package.html 2008-08-29 09:22:29 UTC (rev 1358) +++ trunk/src/jason/stdlib/package.html 2008-08-29 09:59:27 UTC (rev 1359) @@ -1,129 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<body bgcolor="white"> - -Provides all default internal actions of Jason. - -<h2>BDI</h2> -<ul> - <li>{@link jason.stdlib.desire}: check agent's desires.</li> - <li>{@link jason.stdlib.drop_desire}: remove one agent's desire.</li> - <li>{@link jason.stdlib.drop_all_desires}: remove agent's desires.</li> - - - <li>{@link jason.stdlib.intend}: check agent's intentions.</li> - <li>{@link jason.stdlib.drop_intention}: remove one agent's intention.</li> - <li>{@link jason.stdlib.drop_all_intentions}: remove agent's intentions.</li> - <li>{@link jason.stdlib.current_intention}: get a description of the - current intention.</li> - - <li>{@link jason.stdlib.drop_event}: remove one event.</li> - <li>{@link jason.stdlib.drop_all_events}: remove events in the interpreter.</li> - - <li>{@link jason.stdlib.succeed_goal}: abort some goal with success.</li> - <li>{@link jason.stdlib.fail_goal}: abort some goal with failure.</li> - - <li>{@link jason.stdlib.suspend}: suspend intentions.</li> - <li>{@link jason.stdlib.resume}: resume suspended intentions.</li> -</ul> - -<h2>Belief base</h2> -<ul> - <li>{@link jason.stdlib.abolish}: remove some beliefs.</li> - <li>{@link jason.stdlib.findall}: find all beliefs of some kind.</li> - <li>{@link jason.stdlib.count}: count the number of beliefs of some kind.</li> -</ul> - - -<h2>Plan Library</h2> -<ul> - <li>{@link jason.stdlib.add_plan}: add new plans.</li> - <li>{@link jason.stdlib.remove_plan}: remove a plan.</li> - <li>{@link jason.stdlib.plan_label}: get the label of a plan.</li> - <li>{@link jason.stdlib.relevant_plans}: get a list of plans.</li> -</ul> - - - -<h2>Communication</h2> -<ul> - <li>{@link jason.stdlib.send}: send messages. </li> - <li>{@link jason.stdlib.broadcast}: broadcast messages.</li> - <li>{@link jason.stdlib.my_name}: get the agent's name.</li> -</ul> - - -<h2>Lists and Sets</h2> -<ul> - <li>{@link jason.stdlib.member}: list members. </li> - <li>{@link jason.stdlib.length}: size of lists. </li> - - <li>{@link jason.stdlib.concat}: concat lists. </li> - <li>{@link jason.stdlib.delete}: delete members of a lists. </li> - - <li>{@link jason.stdlib.reverse}: reverse lists. </li> - <li>{@link jason.stdlib.nth}: nth element of a lists. </li> - <li>{@link jason.stdlib.max}: maximum value of a lists. </li> - <li>{@link jason.stdlib.min}: minimum value of a lists. </li> - <li>{@link jason.stdlib.sort}: sort lists. </li> - <li>{@link jason.stdlib.list}: check whether an argument is a list.</li> - - <li>{@link jason.stdlib.difference}: difference of sets. </li> - <li>{@link jason.stdlib.intersection}: intersection of sets. </li> - <li>{@link jason.stdlib.union}: union of sets. </li> - -</ul> - - -<h2>String</h2> -<ul> - <li>{@link jason.stdlib.length}: size of strings. </li> - <li>{@link jason.stdlib.concat}: append strings. </li> - <li>{@link jason.stdlib.delete}: delete characters of a string. </li> - <li>{@link jason.stdlib.reverse}: reverse strings. </li> - <li>{@link jason.stdlib.substring}: test substrings of strings. </li> - <li>{@link jason.stdlib.string}: check whether an argument is a string.</li> - <li>{@link jason.stdlib.term2string}: convert terms to strings and vice-versa.</li> -</ul> - -<h2>Execution control</h2> -<ul> - <li>{@link jason.stdlib.conditional}: implementation of <b>if</b>.</li> - <li>{@link jason.stdlib.loop}: implementation of <b>while</b>.</li> - <li>{@link jason.stdlib.foreach}: implementation of <b>for</b>.</li> -</ul> - - -<h2>Meta programming</h2> -<ul> - <li>{@link jason.stdlib.atom}: check whether an argument is an atom (p).</li> - <li>{@link jason.stdlib.structure}: check whether an argument is a structure (p(t1,t2), [a,b]).</li> - <li>{@link jason.stdlib.literal}: check whether an argument is a literal (p(t1,t2), ~p(t1,t2), p(t1,t2)[a1,a2]).</li> - <li>{@link jason.stdlib.list}: check whether an argument is a list ([a,b]).</li> - <li>{@link jason.stdlib.ground}: check whether an argument is ground.</li> - <li>{@link jason.stdlib.number}: check whether an argument is a number (1, 2.3).</li> - <li>{@link jason.stdlib.string}: check whether an argument is a string ("s").</li> - <li>{@link jason.stdlib.ground}: check whether an argument is ground.</li> - <li>{@link jason.stdlib.add_annot}: add an annotation in a literal.</li> - <li>{@link jason.stdlib.add_nested_source}: add a source in a literal.</li> -</ul> - - -<h2>Miscellaneous</h2> -<ul> - <li>{@link jason.stdlib.at}: add a future event.</li> - <li>{@link jason.stdlib.wait}: wait some event.</li> - - <li>{@link jason.stdlib.create_agent}: create a new agent.</li> - <li>{@link jason.stdlib.kill_agent}: kill an agent.</li> - <li>{@link jason.stdlib.stopMAS}: stop all agents.</li> - - <li>{@link jason.stdlib.date}: get the current date.</li> - <li>{@link jason.stdlib.time}: get the current time.</li> - <li>{@link jason.stdlib.fail}: an action that always fails.</li> - <li>{@link jason.stdlib.perceive}: force perception.</li> - <li>{@link jason.stdlib.range}: backtrack values in a range (used in <b>for</b>).</li> -</ul> - -</body> -</html> Modified: trunk/src/jason/stdlib/time.java =================================================================== --- trunk/src/jason/stdlib/time.java 2008-08-29 09:22:29 UTC (rev 1358) +++ trunk/src/jason/stdlib/time.java 2008-08-29 09:59:27 UTC (rev 1359) @@ -36,6 +36,7 @@ </ul> @see jason.stdlib.date + @see jason.functions.time */ public class time extends DefaultInternalAction { This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |