Kaynağa Gözat

cdhclib: doxygenization started

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@57112 15284696-431f-4ddb-bdfa-cd5b030d7da7
Markus Neteler 11 yıl önce
ebeveyn
işleme
76ec03f1e7
2 değiştirilmiş dosya ile 72 ekleme ve 0 silme
  1. 3 0
      lib/cdhc/Makefile
  2. 69 0
      lib/cdhc/cdhclib.dox

+ 3 - 0
lib/cdhc/Makefile

@@ -1,6 +1,7 @@
 MODULE_TOPDIR = ../..
 
 include $(MODULE_TOPDIR)/include/Make/Vars.make
+include $(MODULE_TOPDIR)/include/Make/Doxygen.make
 
 MOD_OBJS := $(filter-out test.o port_test.o,$(AUTO_OBJS))
 
@@ -22,3 +23,5 @@ $(OBJDIR)/test$(EXE): $(OBJDIR)/test.o $(GISDEP) $(CDHCDEP)
 	$(call linker)
 
 $(OBJDIR)/test$(EXE): LIBES = $(GISLIB) $(CDHCLIB)
+
+DOXNAME = cdhc

+ 69 - 0
lib/cdhc/cdhclib.dox

@@ -0,0 +1,69 @@
+/*! \page cdhclib GRASS testing normality & exponentiality Library
+
+by GRASS Development Team (http://grass.osgeo.org)
+
+\tableofcontents
+
+\section cdhcintro GRASS testing normality & exponentiality library
+
+- Moments \sqrt{b_1} and b_2
+- Geary's a-statistic & an approx. normal
+- Extreme normal deviates
+- D'Agostino's D & an approx. normal
+- Kuiper's V (regular & modified for normality)
+- Watson's U^2 (regular & modified for normality)
+- Durbin's Exact Test (modified Kolmogorov)
+- Anderson-Darling's A^2 (regular & modified for normality)
+- Cramer-Von Mises W^2(regular & modified for normality)
+- Kolmogorov-Smirnov's D (regular & modified for normality)
+- Chi-Square stat (equal probability classes) and d.f.
+- Shapiro-Wilk W
+- Weisberg-Bingham's W''
+- Shapiro-Wilk W''
+- Kotz' T'_f (Lognormality vs. Normality)
+
+\section Loading_the_CDHC_Library Loading the CDHC Library
+
+The library is loaded by specifying
+
+\verbatim
+$(CDHCLIB)
+\endverbatim
+
+in the <tt>Makefile</tt>.
+
+\section listOfFunctios List of functions
+
+- anderson_darling()
+- anderson_darling_exp()
+- chi_square()
+- chi_square_exp()
+- coeff_variation()
+- cramer_von_mises()
+- cramer_von_mises_exp()
+- dagostino_d()
+- dmax()
+- dmax_exp()
+- durbins_exact()
+- enormp()
+- extreme()
+- geary_test()
+- kolmogorov_smirnov()
+- kolmogorov_smirnov_exp()
+- kotz_families()
+- kuipers_v()
+- kuipers_v_exp()
+- mod_maxlik_ratio()
+- normp()
+- omnibus_moments()
+- royston()
+- shapiro_francia()
+- shapiro_wilk()
+- shapiro_wilk_exp()
+- watson_u2()
+- watson_u2_exp()
+- weisberg_bingham()
+- xinormal()
+
+*/
+