Changeset 14628 for trunk/FACT++

Timestamp:

11/15/12 22:34:26 (12 years ago)

Author:

tbretz

Message:

Added jsdoc for JavaScript documentation.

Location:

trunk/FACT++

Files:

• Makefile.am (modified) (2 diffs)
• Makefile.in (modified) (4 diffs)
• configure (modified) (9 diffs)
• configure.ac (modified) (5 diffs)

trunk/FACT++/Makefile.am

@@ -537 +537 @@
 endif
 
+if HAS_JSDOC
+MAN_TARGETS += jsdoc
+endif
+
 $(dist_man1_MANS): $(dist_man1_MANS:.man=)
         @mkdir -p man
@@ -546 +550 @@
 .man.pdf: $<
         $(AM_V_GEN)groff -mandoc `man -w -l $<` | ps2pdf - $@
+
+jsdoc:
+        jsdoc -d=html/dimctrl scripts/doc
+
 
 man: $(MAN_TARGETS) doxygen-doc

trunk/FACT++/Makefile.in

@@ -86 +86 @@
 @HAS_GROFF_TRUE@@HAS_PS2PDF_TRUE@am__append_16 = $(dist_man1_MANS:.man=.pdf)
 @HAS_GROFF_TRUE@@HAS_PS2PDF_TRUE@am__append_17 = $(dist_man1_MANS:.man=.pdf)
+@HAS_JSDOC_TRUE@am__append_18 = jsdoc
 subdir = .
 ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
@@ -619 +620 @@
 INSTALL_SCRIPT = @INSTALL_SCRIPT@
 INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@
+JSDOC = @JSDOC@
 LD = @LD@
 LDFLAGS = @LDFLAGS@
@@ -1136 +1138 @@
 
 #-------------------------------------------------------------------------
-MAN_TARGETS = $(dist_man1_MANS) $(am__append_12) $(am__append_15)
+MAN_TARGETS = $(dist_man1_MANS) $(am__append_12) $(am__append_15) \
+        $(am__append_18)
 all: $(BUILT_SOURCES)
         $(MAKE) $(AM_MAKEFLAGS) all-am
@@ -2799 +2802 @@
         $(AM_V_GEN)groff -mandoc `man -w -l $<` | ps2pdf - $@
 
+jsdoc:
+        jsdoc -d=html/dimctrl scripts/doc
+
 man: $(MAN_TARGETS) doxygen-doc
 

trunk/FACT++/configure

@@ -662 +662 @@
 HAS_DOXYGEN_FALSE
 HAS_DOXYGEN_TRUE
+HAS_JSDOC_FALSE
+HAS_JSDOC_TRUE
 HAS_HELP2MAN_FALSE
 HAS_HELP2MAN_TRUE
@@ -670 +672 @@
 HAS_COLORDIFF_FALSE
 HAS_COLORDIFF_TRUE
+JSDOC
 HELP2MAN
 PS2PDF
@@ -23974 +23977 @@
 
                 cat > conftest.$ac_ext <<EOF
-#line 23976 "configure"
+#line 23979 "configure"
 #include "confdefs.h"
 #include <qglobal.h>
@@ -24945 +24948 @@
 
 
+# Extract the first word of "jsdoc", so it can be a program name with args.
+set dummy jsdoc; ac_word=$2
+{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5
+$as_echo_n "checking for $ac_word... " >&6; }
+if ${ac_cv_prog_JSDOC+:} false; then :
+  $as_echo_n "(cached) " >&6
+else
+  if test -n "$JSDOC"; then
+  ac_cv_prog_JSDOC="$JSDOC" # Let the user override the test.
+else
+as_save_IFS=$IFS; IFS=$PATH_SEPARATOR
+for as_dir in $PATH
+do
+  IFS=$as_save_IFS
+  test -z "$as_dir" && as_dir=.
+    for ac_exec_ext in '' $ac_executable_extensions; do
+  if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then
+    ac_cv_prog_JSDOC="yes"
+    $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5
+    break 2
+  fi
+done
+  done
+IFS=$as_save_IFS
+
+  test -z "$ac_cv_prog_JSDOC" && ac_cv_prog_JSDOC="no"
+fi
+fi
+JSDOC=$ac_cv_prog_JSDOC
+if test -n "$JSDOC"; then
+  { $as_echo "$as_me:${as_lineno-$LINENO}: result: $JSDOC" >&5
+$as_echo "$JSDOC" >&6; }
+else
+  { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5
+$as_echo "no" >&6; }
+fi
+
+
 
 ##########################################################################
@@ -25001 +25042 @@
   HAS_HELP2MAN_TRUE='#'
   HAS_HELP2MAN_FALSE=
+fi
+
+ if test "$JSDOC" = yes; then
+  HAS_JSDOC_TRUE=
+  HAS_JSDOC_FALSE='#'
+else
+  HAS_JSDOC_TRUE='#'
+  HAS_JSDOC_FALSE=
 fi
 
@@ -25454 +25503 @@
 if test -z "${HAS_HELP2MAN_TRUE}" && test -z "${HAS_HELP2MAN_FALSE}"; then
   as_fn_error $? "conditional \"HAS_HELP2MAN\" was never defined.
+Usually this means the macro was only invoked conditionally." "$LINENO" 5
+fi
+if test -z "${HAS_JSDOC_TRUE}" && test -z "${HAS_JSDOC_FALSE}"; then
+  as_fn_error $? "conditional \"HAS_JSDOC\" was never defined.
 Usually this means the macro was only invoked conditionally." "$LINENO" 5
 fi
@@ -28073 +28126 @@
 
 fi
+if test -z "$HAS_JSDOC_TRUE"; then :
+  { $as_echo "$as_me:${as_lineno-$LINENO}:  JavaScript docu        / 'jsdoc'            found: yes" >&5
+$as_echo "$as_me:  JavaScript docu        / 'jsdoc'            found: yes" >&6;}
+else
+  { $as_echo "$as_me:${as_lineno-$LINENO}:  JavaScript docu        / 'jsdoc'            found: no" >&5
+$as_echo "$as_me:  JavaScript docu        / 'jsdoc'            found: no" >&6;}
+
+fi
 if test -z "$HAS_HELP2MAN_TRUE"; then :
 
@@ -28195 +28256 @@
 
 fi
+if test -z "$HAS_JSDOC_TRUE"; then :
+  { $as_echo "$as_me:${as_lineno-$LINENO}:  jsdoc:         build JavaScript documentation with jsdoc" >&5
+$as_echo "$as_me:  jsdoc:         build JavaScript documentation with jsdoc" >&6;}
+
+fi
 { $as_echo "$as_me:${as_lineno-$LINENO}:  man:           build all buildable documentation" >&5
 $as_echo "$as_me:  man:           build all buildable documentation" >&6;}
@@ -28267 +28333 @@
 
 fi
+if test -z "$HAS_JSDOC_TRUE"; then :
+  else
+  { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING:  JavaScript documentation disabled!" >&5
+$as_echo "$as_me: WARNING:  JavaScript documentation disabled!" >&2;}
+fi
 if test -z "$HAS_SQL_TRUE"; then :
   else

trunk/FACT++/configure.ac

@@ -343 +343 @@
 AC_CHECK_PROG(PS2PDF,    ps2pdf,       yes, no)
 AC_CHECK_PROG(HELP2MAN,  help2man,     yes, no)
+AC_CHECK_PROG(JSDOC,     jsdoc,        yes, no)
 
 ##########################################################################
@@ -373 +374 @@
 AM_CONDITIONAL(HAS_PS2PDF,    [test "$PS2PDF" = yes])
 AM_CONDITIONAL(HAS_HELP2MAN,  [test "$HELP2MAN" = yes])
+AM_CONDITIONAL(HAS_JSDOC,     [test "$JSDOC" = yes])
 AM_CONDITIONAL(HAS_DOXYGEN,   [test "$DX_DOXYGEN"])
 AM_CONDITIONAL(HAS_DOT,       [test "$DX_DOT"])
@@ -492 +494 @@
    AC_MSG_NOTICE([ colored svn diff       / 'colordiff'        found: no])
 )
+AM_COND_IF(HAS_JSDOC,
+   AC_MSG_NOTICE([ JavaScript docu        / 'jsdoc'            found: yes]),
+   AC_MSG_NOTICE([ JavaScript docu        / 'jsdoc'            found: no])
+)
 AM_COND_IF(HAS_HELP2MAN,[
    AC_MSG_NOTICE([ man-pages enabled      / 'help2man'         found: $HELP2MAN])
@@ -554 +560 @@
    AC_MSG_NOTICE([ doxygen-doc:   build html and pdf documentation with doxygen])
 )
+AM_COND_IF(HAS_JSDOC,
+   AC_MSG_NOTICE([ jsdoc:         build JavaScript documentation with jsdoc])
+)
 AC_MSG_NOTICE([ man:           build all buildable documentation])
 AC_MSG_NOTICE()
@@ -583 +592 @@
       AC_MSG_WARN([ Either of the necessary packages not found - viewer GUI disabled!])
 )
+AM_COND_IF(HAS_JSDOC,,   AC_MSG_WARN([ JavaScript documentation disabled!]))
 AM_COND_IF(HAS_SQL,,     AC_MSG_WARN([ database support globally disabled!]))
 AM_COND_IF(HAS_NOVA,,    AC_MSG_WARN([ libnova missing - smartfact will be compiles without astronomy support!]))