diff --git a/configure.ac b/configure.ac index dabb5252..c8f8c76d 100644 --- a/configure.ac +++ b/configure.ac @@ -14,7 +14,7 @@ m4_define(FLARQ_MAJOR, [4]) m4_define(FLARQ_MINOR, [3]) m4_define(FLARQ_PATCH, [.5]) -AC_INIT([fldigi], FLDIGI_MAJOR.FLDIGI_MINOR[]FLDIGI_PATCH, [fldigi-devel@lists.berlios.de]) +AC_INIT([fldigi], FLDIGI_MAJOR.FLDIGI_MINOR[]FLDIGI_PATCH, [fldigi-devel@sourceforge.net]) # substitute in Makefiles AC_SUBST([FLDIGI_VERSION_MAJOR], [FLDIGI_MAJOR]) @@ -67,7 +67,7 @@ AC_DEFINE_UNQUOTED([FLDIGI_AUTHORS], ["$FLDIGI_AUTHORS"], [Fldigi authors]) AC_DEFINE_UNQUOTED([FLARQ_AUTHORS], ["$FLARQ_AUTHORS"], [Flarq authors]) AC_DEFINE_UNQUOTED([PACKAGE_HOME], ["$PACKAGE_HOME"], [Home page]) AC_DEFINE_UNQUOTED([PACKAGE_DL], ["$PACKAGE_DL"], [Download page]) -AC_DEFINE_UNQUOTED([PACKAGE_PROJ], ["$PACKAGE_PROJ"], [BerliOS page]) +AC_DEFINE_UNQUOTED([PACKAGE_PROJ], ["$PACKAGE_PROJ"], [Sourceforge page]) AC_DEFINE_UNQUOTED([PACKAGE_NEWBUG], ["$PACKAGE_NEWBUG"], [Trac new ticket page]) AC_DEFINE_UNQUOTED([PACKAGE_DOCS], ["$PACKAGE_DOCS"], [Docs index]) AC_DEFINE_UNQUOTED([PACKAGE_GUIDE], ["$PACKAGE_GUIDE"], [Beginners guide]) diff --git a/doc/flarq.1.txt b/doc/flarq.1.txt index f098faa0..496974b5 100644 --- a/doc/flarq.1.txt +++ b/doc/flarq.1.txt @@ -126,7 +126,7 @@ Flarq web site: http://www.w1hkj.com/flarq_main.html Fldigi web site: http://www.w1hkj.com/Fldigi.html -BerliOS project page: http://developer.berlios.de/projects/fldigi/ +Sourceforge project page: http://sourceforge.net/projects/fldigi/ ARQ specification by Paul Schmidt, K9PS: http://www.w1hkj.com/FlarqHelpFiles/ARQ2.pdf diff --git a/doc/fldigi.1.txt b/doc/fldigi.1.txt index dadf70b8..4a6348a8 100644 --- a/doc/fldigi.1.txt +++ b/doc/fldigi.1.txt @@ -443,7 +443,7 @@ getaddrinfo(3), getopt(3), regex(7), X(7) == RESOURCES == Main web site: http://www.w1hkj.com/Fldigi.html -BerliOS project page: http://developer.berlios.de/projects/fldigi/ +Sourceforge project page: http://sourceforge.net/projects/fldigi/ Wiki and bug tracker: https://fedorahosted.org/fldigi/ diff --git a/scripts/doxygen/gen_doxygen_docs.sh b/scripts/doxygen/gen_doxygen_docs.sh index 60d07572..9627e344 100755 --- a/scripts/doxygen/gen_doxygen_docs.sh +++ b/scripts/doxygen/gen_doxygen_docs.sh @@ -1,6 +1,6 @@ #! /bin/bash -e # -# KL4YFD 2013 +# Copyright (C) KL4YFD 2013-2015 # Released under GNU GPL # @@ -12,19 +12,21 @@ cd $( dirname ${BASH_SOURCE[0]} ) function usage { printf "\n\nThis script generates Doxygen documentation from the " - printf "\nfldigi sourcecode. By default, the tool \"cppcheck\" is also called. \nNote: This analysis takes longer than compilation and produces about 1.8GiB of data." + printf "\nfldigi sourcecode. Unless disabled, the tool \"cppcheck\" is also called. \nNote: This analysis takes longer than compilation and produces about 2000 MiB of data on-disk." printf "\n\nUsage:" printf "\n\tGenerate Doxygen documentation:\t ./gen_doxygen_docs.sh run" + printf "\n\tGenerate Doxygen documentation without Cppcheck:\t ./gen_doxygen_docs.sh nocppcheck" printf "\n\tClean up after Doxygen run:\t ./gen_doxygen_docs.sh clean" - printf "\n\tClean up after Doxygen run:\t ./gen_doxygen_docs.sh nocppcheck" printf "\n\tPrint this usage summary:\t ./gen_doxygen_docs.sh help \n\n" } function doxygen_clean { rm -Rf HTML - printf "\ndoxygen documentation deleted!\n" + printf "\n\nDoxygen documentation deleted!\n\n" } +# set defaults +nocppcheck_flag=false case "$1" in "run") @@ -34,11 +36,11 @@ case "$1" in break ;; "nocppcheck") - cppcheck_clean - exit + ../tests/cppcheck/gen_cppcheck_results.sh clean + nocppcheck_flag=true ;; "clean") - doxygen_clean + doxygen_clean # this auto-catches the gitstats files also ../tests/cppcheck/gen_cppcheck_results.sh clean exit ;; @@ -79,6 +81,14 @@ if ! which mscgen ; then exit 1 fi +# Ensure the binary "gitstats" is on the system +if ! which gitstats ; then + printf "\n\nERROR: Generating the Fldigi Doxygen documents requires the program: gitstats" + printf "\n\tPlease install this program to continue." + printf "\n\n === ABORTING === \n\n" + exit 1 +fi + # Ensure the Doxygen config file exists if [ ! -e ./fldigi_doxyfile.txt ]; then printf "\n\nERROR: Doxygen configuration file: \"fldigi_doxyfile.txt\" not found." @@ -86,13 +96,19 @@ if [ ! -e ./fldigi_doxyfile.txt ]; then exit 1 fi -doxygen fldigi_doxyfile.txt + +mkdir HTML # just in case + +doxygen fldigi_doxyfile.txt # this takes a while + +gitstats ../../ ./HTML/GITSTATS # this is pretty fast + # Go create some really useful information using git cd HTML mkdir __git; cd __git - git format-patch --summary -n HEAD~125 # Create patches for the last 125 commits - git log --stat -n 125 > gitlog.txt # Dump the history of the last 125 commits + git format-patch --summary -n HEAD~100 # Create patches for the last 100 commits + git log --stat -n 100 > gitlog.txt # Dump the history of the last 100 commits cd .. cd .. @@ -100,7 +116,9 @@ if ! which cppcheck ; then printf "\n\nWARNING: Binary \"cppcheck\" not found." printf "\n\n\t Skipping sourcecode analysis. Install cppcheck and re-run.\n\n" else - ../tests/cppcheck/gen_cppcheck_results.sh run + if [ "$nocppcheck_flag" != true ];then + ../tests/cppcheck/gen_cppcheck_results.sh run + fi fi printf "\n\n === DOXYGEN documentation generation complete. ===" diff --git a/src/include/doxygen.h b/src/include/doxygen.h index d052070f..b21bee2e 100644 --- a/src/include/doxygen.h +++ b/src/include/doxygen.h @@ -1,7 +1,7 @@ // ---------------------------------------------------------------------------- // doxygen.h // -// Copyright (C) 2013 +// Copyright (C) 2013-2015 // John Phelps, KL4YFD // // This file is part of fldigi. @@ -27,7 +27,7 @@ */ -/** \mainpage Fldigi 3.21 doxygen documentation +/** \mainpage Fldigi Developer Doxygen Documentation
\section intro Introduction @@ -48,13 +48,14 @@ \section download To Download Fldigi : - + \section entry Good Entry-Points for Navigating the Doxygen Documentation :