Updating doxygen support.

Perry Werneck
1 parent 46ce8b7a
Showing 4 changed files with 16 additions and 15 deletions Show diff stats
Makefile.in
doxygen/doxyfile.in
src/include/lib3270.h
src/lib3270/session.c
@@ -142,7 +142,6 @@ lib@LIB3270_NAME@.pot: \
 doc:
 	@$(DOXYGEN) doxygen/doxyfile
  
-
 #---[ Install Targets ]------------------------------------------------------------------
  
 install:
@@ -74,7 +74,7 @@ CREATE_SUBDIRS         = NO
 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
  
-OUTPUT_LANGUAGE        = Portuguese
+OUTPUT_LANGUAGE        = English
  
 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
 # include brief member descriptions after the members that are listed in
@@ -648,7 +648,7 @@ WARN_FORMAT            = &quot;$file:$line: $text&quot;
 # and error messages should be written. If left blank the output is written
 # to stderr.
  
-WARN_LOGFILE           = doxygen.log
+WARN_LOGFILE           = @BASEDIR@/doxygen/doxygen.log
  
 #---------------------------------------------------------------------------
 # configuration options related to the input files
@@ -711,8 +711,8 @@ FILE_PATTERNS          = *.c \
                          *.for \
                          *.vhd \
                          *.vhdl \
-						 *.js \
-						 *.xml
+			 *.js \
+			 *.xml
  
 # 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.
@@ -1401,7 +1401,7 @@ RTF_EXTENSIONS_FILE    =
 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
 # generate man pages
  
-GENERATE_MAN           = NO
+GENERATE_MAN           = YES
  
 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
@@ -1753,7 +1753,7 @@ DOT_IMAGE_FORMAT       = png
 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
 # visible. Older versions of IE do not have SVG support.
  
-INTERACTIVE_SVG        = NO
+INTERACTIVE_SVG        = YES
  
 # The tag DOT_PATH can be used to specify the path where the dot tool can be
 # found. If left blank, it is assumed the dot tool can be found in the path.
@@ -392,23 +392,19 @@
 	LIB3270_EXPORT unsigned int lib3270_get_length(H3270 *h);
  
 	/**
-	 * Start a new session (INCOMPLETE).
-	 *
-	 * Initialize session structure, opens a new session.
-	 * WARNING: Multi session ins't yet supported in lib3270, because of this
-	 * this call always return the handle of the same session.
+	 * @brief Creates an empty TN3270 session.
 	 *
 	 * @param model	Terminal model.
 	 *
-	 * @return lib3270 internal session structure.
+	 * @return Handle of the new session.
 	 *
 	 */
 	LIB3270_EXPORT H3270 * lib3270_session_new(const char *model);
  
 	/**
-	 * Destroy session, release memory.
+	 * @brief Closes a TN3270 session releasing resources.
 	 *
-	 * @param h		Session handle.
+	 * @param h handle of the session to close.
 	 *
 	 */
 	LIB3270_EXPORT void lib3270_session_free(H3270 *h);
@@ -55,6 +55,12 @@
  
 /*---[ Implement ]------------------------------------------------------------------------------------------------------------*/
  
+/**
+ * @brief Closes a TN3270 session releasing resources.
+ *
+ * @param h handle of the session to close.
+ *
+ */
 void lib3270_session_free(H3270 *h)
 {
 	size_t f;
...	...	@@ -142,7 +142,6 @@ lib@LIB3270_NAME@.pot: \
142	142	doc:
143	143	@$(DOXYGEN) doxygen/doxyfile
144	144
145		-
146	145	#---[ Install Targets ]------------------------------------------------------------------
147	146
148	147	install:
...	...
...	...	@@ -74,7 +74,7 @@ CREATE_SUBDIRS = NO
74	74	# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75	75	# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
76	76
77		-OUTPUT_LANGUAGE = Portuguese
	77	+OUTPUT_LANGUAGE = English
78	78
79	79	# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80	80	# include brief member descriptions after the members that are listed in
...	...	@@ -648,7 +648,7 @@ WARN_FORMAT = "$file:$line: $text"
648	648	# and error messages should be written. If left blank the output is written
649	649	# to stderr.
650	650
651		-WARN_LOGFILE = doxygen.log
	651	+WARN_LOGFILE = @BASEDIR@/doxygen/doxygen.log
652	652
653	653	#---------------------------------------------------------------------------
654	654	# configuration options related to the input files
...	...	@@ -711,8 +711,8 @@ FILE_PATTERNS = *.c \
711	711	*.for \
712	712	*.vhd \
713	713	*.vhdl \
714		- *.js \
715		- *.xml
	714	+ *.js \
	715	+ *.xml
716	716
717	717	# The RECURSIVE tag can be used to turn specify whether or not subdirectories
718	718	# should be searched for input files as well. Possible values are YES and NO.
...	...	@@ -1401,7 +1401,7 @@ RTF_EXTENSIONS_FILE =
1401	1401	# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1402	1402	# generate man pages
1403	1403
1404		-GENERATE_MAN = NO
	1404	+GENERATE_MAN = YES
1405	1405
1406	1406	# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1407	1407	# If a relative path is entered the value of OUTPUT_DIRECTORY will be
...	...	@@ -1753,7 +1753,7 @@ DOT_IMAGE_FORMAT = png
1753	1753	# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1754	1754	# visible. Older versions of IE do not have SVG support.
1755	1755
1756		-INTERACTIVE_SVG = NO
	1756	+INTERACTIVE_SVG = YES
1757	1757
1758	1758	# The tag DOT_PATH can be used to specify the path where the dot tool can be
1759	1759	# found. If left blank, it is assumed the dot tool can be found in the path.
...	...
...	...	@@ -392,23 +392,19 @@
392	392	LIB3270_EXPORT unsigned int lib3270_get_length(H3270 *h);
393	393
394	394	/**
395		- * Start a new session (INCOMPLETE).
396		- *
397		- * Initialize session structure, opens a new session.
398		- * WARNING: Multi session ins't yet supported in lib3270, because of this
399		- * this call always return the handle of the same session.
	395	+ * @brief Creates an empty TN3270 session.
400	396	*
401	397	* @param model Terminal model.
402	398	*
403		- * @return lib3270 internal session structure.
	399	+ * @return Handle of the new session.
404	400	*
405	401	*/
406	402	LIB3270_EXPORT H3270 * lib3270_session_new(const char *model);
407	403
408	404	/**
409		- * Destroy session, release memory.
	405	+ * @brief Closes a TN3270 session releasing resources.
410	406	*
411		- * @param h Session handle.
	407	+ * @param h handle of the session to close.
412	408	*
413	409	*/
414	410	LIB3270_EXPORT void lib3270_session_free(H3270 *h);
...	...
...	...	@@ -55,6 +55,12 @@
55	55
56	56	/---[ Implement ]------------------------------------------------------------------------------------------------------------/
57	57
	58	+/**
	59	+ * @brief Closes a TN3270 session releasing resources.
	60	+ *
	61	+ * @param h handle of the session to close.
	62	+ *
	63	+ */
58	64	void lib3270_session_free(H3270 *h)
59	65	{
60	66	size_t f;
...	...