Commit dfbe6353 authored by Guillaume Duhamel's avatar Guillaume Duhamel
Browse files

Add briefs to fill out user documentation.


	* mln/accu/bbox.hh,
	* mln/accu/compute.hh,
	* mln/accu/count.hh,
	* mln/accu/histo.hh,
	* mln/accu/max.hh,
	* mln/accu/max_h.hh,
	* mln/accu/mean.hh,
	* mln/accu/median.hh,
	* mln/accu/median_alt.hh,
	* mln/accu/min.hh,
	* mln/accu/min_h.hh,
	* mln/accu/min_max.hh,
	* mln/accu/nil.hh,
	* mln/accu/p.hh,
	* mln/accu/pair.hh,
	* mln/accu/sum.hh,
	* mln/accu/take.hh,
	* mln/accu/v.hh,
	* mln/core/concept/function.hh,
	* mln/core/mesh_window_piter.hh,
	* mln/fun/v2v/linear.hh,
	* mln/trait/promote.hh,
	* mln/util/ordpair.hh,
	* mln/value/lut_vec.hh,
	* mln/value/set.hh: Fix briefs of structures/classes of these files.

	* doc/Makefile.am: Remove the generation of the TODO list in user
	documentation.

git-svn-id: https://svn.lrde.epita.fr/svn/oln/trunk@1619 4aad255d-cdde-0310-9447-f3009e2ae8c0
parent 215810bf
2007-12-19 Guillaume Duhamel <guillaume.duhamel@lrde.epita.fr>
Add briefs to fill out user documentation.
* mln/accu/bbox.hh,
* mln/accu/compute.hh,
* mln/accu/count.hh,
* mln/accu/histo.hh,
* mln/accu/max.hh,
* mln/accu/max_h.hh,
* mln/accu/mean.hh,
* mln/accu/median.hh,
* mln/accu/median_alt.hh,
* mln/accu/min.hh,
* mln/accu/min_h.hh,
* mln/accu/min_max.hh,
* mln/accu/nil.hh,
* mln/accu/p.hh,
* mln/accu/pair.hh,
* mln/accu/sum.hh,
* mln/accu/take.hh,
* mln/accu/v.hh,
* mln/core/concept/function.hh,
* mln/core/mesh_window_piter.hh,
* mln/fun/v2v/linear.hh,
* mln/trait/promote.hh,
* mln/util/ordpair.hh,
* mln/value/lut_vec.hh,
* mln/value/set.hh: Fix briefs of structures/classes of these files.
* doc/Makefile.am: Remove the generation of the TODO list in user
documentation.
2007-12-18 Guillaume Duhamel <guillaume.duhamel@lrde.epita.fr>
Reduce warnings for Doxygen.
......
......@@ -16,22 +16,23 @@ html_user:: Doxyfile
$(DOXYGEN) $(srcdir)/Doxyfile_user
edit = sed -e "s|@ID@|$$Id|" \
-e 's,@PACKAGE_NAME\@,$(PACKAGE_NAME),g' \
-e 's,@PACKAGE_VERSION\@,$(PACKAGE_VERSION),g' \
-e 's,@top_builddir\@,$(top_builddir),g' \
edit = sed -e "s|@ID@|$$Id|" \
-e 's,@PACKAGE_NAME\@,$(PACKAGE_NAME),g' \
-e 's,@PACKAGE_VERSION\@,$(PACKAGE_VERSION),g' \
-e 's,@top_builddir\@,$(top_builddir),g' \
-e 's,@top_srcdir\@,$(top_srcdir),g'
edit_user = sed -e 's,OUTPUT_DIRECTORY = ./internal/,OUTPUT_DIRECTORY = ./user/,g' \
-e 's,EXTRACT_ALL = YES,EXTRACT_ALL = NO,g' \
-e 's,EXTRACT_PRIVATE = YES,EXTRACT_PRIVATE = NO,g' \
-e 's,EXTRACT_STATIC = YES,EXTRACT_STATIC = NO,g' \
-e 's,EXTRACT_LOCAL_CLASSES = YES,EXTRACT_LOCAL_CLASSES = NO,g' \
-e 's,HIDE_UNDOC_MEMBERS = NO,HIDE_UNDOC_MEMBERS = YES,g' \
-e 's,HIDE_UNDOC_CLASSES = NO,HIDE_UNDOC_CLASSES = YES,g' \
-e 's,HIDE_FRIEND_COMPOUNDS = NO,HIDE_FRIEND_COMPOUNDS = YES,g' \
-e 's,HIDE_IN_BODY_DOCS = NO,HIDE_IN_BODY_DOCS = YES,g' \
-e 's,INTERNAL_DOCS = YES,INTERNAL_DOCS = NO,g' \
edit_user = sed -e 's,OUTPUT_DIRECTORY = ./internal/,OUTPUT_DIRECTORY = ./user/,g' \
-e 's,EXTRACT_ALL = YES,EXTRACT_ALL = NO,g' \
-e 's,EXTRACT_PRIVATE = YES,EXTRACT_PRIVATE = NO,g' \
-e 's,EXTRACT_STATIC = YES,EXTRACT_STATIC = NO,g' \
-e 's,EXTRACT_LOCAL_CLASSES = YES,EXTRACT_LOCAL_CLASSES = NO,g' \
-e 's,HIDE_UNDOC_MEMBERS = NO,HIDE_UNDOC_MEMBERS = YES,g' \
-e 's,HIDE_UNDOC_CLASSES = NO,HIDE_UNDOC_CLASSES = YES,g' \
-e 's,HIDE_FRIEND_COMPOUNDS = NO,HIDE_FRIEND_COMPOUNDS = YES,g' \
-e 's,HIDE_IN_BODY_DOCS = NO,HIDE_IN_BODY_DOCS = YES,g' \
-e 's,INTERNAL_DOCS = YES,INTERNAL_DOCS = NO,g' \
-e 's,GENERATE_TODOLIST = YES,GENERATE_TODOLIST = NO,g' \
-e 's,PROJECT_NUMBER = \",PROJECT_NUMBER = \"User documentation ,g'
EXTRA_DIST = Doxyfile.in
......@@ -44,8 +45,8 @@ CLEANFILES = Doxyfile_internal \
# Moreover, this file is updated whenever ChangeLog is touched: using
# sed instead of configure saves us a lot of time.
Doxyfile: $(top_srcdir)/ChangeLog $(srcdir)/Doxyfile.in
Id=`grep '^\$$Id' $(top_srcdir)/ChangeLog`; \
$(edit) $(srcdir)/Doxyfile.in >Doxyfile_internal; \
Id=`grep '^\$$Id' $(top_srcdir)/ChangeLog`; \
$(edit) $(srcdir)/Doxyfile.in >Doxyfile_internal; \
$(edit_user) $(srcdir)/Doxyfile_internal >Doxyfile_user
clean-local:
......
......@@ -44,7 +44,7 @@ namespace mln
{
/*! Generic bbox accumulator class.
/*! \brief Generic bbox accumulator class.
*
* The parameter \c P is the type of points.
*/
......
......@@ -46,7 +46,7 @@ namespace mln
namespace accu
{
/*! Make an accumulator compute the pixels of the image \p input.
/*! \brief Make an accumulator compute the pixels of the image \p input.
*
* \param[in] input The input image.
*
......@@ -61,7 +61,16 @@ namespace mln
compute(const Image<I>& input);
// FIXME: Doc!
/*! \brief Make an accumulator compute the pixels of the image \p input.
*
* \param[in] input The input image.
*
* This routine runs: \n
* a.take(make::pix(input, p));
* on all pixels on the images.
*
* \warning This routine does not perform a.init().
*/
template <typename A, typename I>
mln_accu_with(A, util::pix<I>)::result
compute(const Image<I>& input);
......
......@@ -44,7 +44,10 @@ namespace mln
{
/*! Generic counter accumulator class.
/*!
* \brief Generic counter accumulator class.
*
* The parameter \a T is the type to be count.
*/
template <typename T>
struct count_ : public mln::accu::internal::base_< std::size_t , count_<T> >
......@@ -67,7 +70,9 @@ namespace mln
};
// FIXME: Doc!
/*!
* \brief Meta accumulator for count.
*/
struct count : public Meta_Accumulator< count >
{
template <typename T>
......
......@@ -50,7 +50,8 @@ namespace mln
{
/*! Generic histogram class over a value set with type \c S.
/*!
* \brief Generic histogram class over a value set with type \c S.
*/
template <typename S>
struct histo : public mln::accu::internal::base_< const std::vector<std::size_t>& , histo<S> >
......@@ -83,7 +84,6 @@ namespace mln
std::size_t sum_;
};
template <typename S>
std::ostream& operator<<(std::ostream& ostr, const histo<S>& h);
......
......@@ -46,7 +46,7 @@ namespace mln
{
/*! Generic max accumulator class.
/*! \brief Generic max accumulator class.
*
* The parameter \c T is the type of values.
*/
......@@ -74,7 +74,9 @@ namespace mln
template <typename I> struct max_< util::pix<I> >;
// FIXME: Doc!
/*!
* \brief Meta accumulator for max.
*/
struct max : public Meta_Accumulator< max >
{
template <typename T>
......
......@@ -44,7 +44,7 @@ namespace mln
{
/*! Generic max function based on histogram over a value set with
/*! \brief Generic max function based on histogram over a value set with
* type \c S.
*/
template <typename S>
......
......@@ -47,7 +47,7 @@ namespace mln
{
/*! Generic mean accumulator class.
/*! \brief Generic mean accumulator class.
*
* Parameter \c T is the type of values that we sum. Parameter \c
* S is the type to store the sum of values; the default type of
......@@ -83,8 +83,9 @@ namespace mln
struct mean_< util::pix<I>, S,M >;
// FIXME: Doc!
/*!
* \brief Meta accumulator for mean.
*/
struct mean : public Meta_Accumulator< mean >
{
template < typename T,
......
......@@ -44,8 +44,8 @@ namespace mln
{
/*! Generic median function based on histogram over a value set
* with type \c S.
/*! \brief Generic median function based on histogram over a value
* set with type \c S.
*/
template <typename S>
struct median : public mln::accu::internal::base_< mln_value(S), median<S> >
......
......@@ -44,8 +44,8 @@ namespace mln
{
/*! Generic median_alt function based on histogram over a value set
* with type \c S.
/*! \brief Generic median_alt function based on histogram over a
* value set with type \c S.
*/
template <typename S>
struct median_alt : : public mln::accu::internal::base_< mln_value(S), median_alt<S> >
......
......@@ -46,7 +46,7 @@ namespace mln
{
/*! Generic min accumulator class.
/*! \brief Generic min accumulator class.
*
* The parameter \c T is the type of values.
*/
......@@ -74,7 +74,9 @@ namespace mln
template <typename I> struct min_< util::pix<I> >;
// FIXME: Doc!
/*!
* \brief Meta accumulator for min.
*/
struct min : public Meta_Accumulator< min >
{
template <typename T>
......
......@@ -44,8 +44,8 @@ namespace mln
{
/*! Generic min function based on histogram over a value set with
* type \c S.
/*! \brief Generic min function based on histogram over a value
* set with type \c S.
*/
template <typename S>
struct min_h : public mln::accu::internal::base_< mln_value(S) , min_h<S> >
......
......@@ -50,7 +50,7 @@ namespace mln
namespace accu
{
/*! Generic min and max accumulator class.
/*! \brief Generic min and max accumulator class.
*
* The parameter \c V is the type of values.
*/
......
......@@ -47,7 +47,8 @@ namespace mln
namespace accu
{
/*! Define an accumulator that does nothing.
/*!
* \brief Define an accumulator that does nothing.
*/
template <typename T>
struct nil_ : public mln::accu::internal::base_< util::ignore , nil_<T> >
......@@ -66,8 +67,9 @@ namespace mln
};
// FIXME: Doc!
/*!
* \brief Meta accumulator for nil.
*/
struct nil : public Meta_Accumulator< nil >
{
template <typename V>
......
......@@ -46,7 +46,8 @@ namespace mln
{
/*! Generic p of accumulators.
/*!
* \brief Generic p of accumulators.
*
* The parameter \c V is the type of values.
*/
......@@ -72,8 +73,9 @@ namespace mln
};
// FIXME: Doc!
/*!
* \brief Meta accumulator for p.
*/
template <typename mA>
struct p : public Meta_Accumulator< p<mA> >
{
......
......@@ -49,7 +49,7 @@ namespace mln
{
/*! Generic pair of accumulators.
/*! \brief Generic pair of accumulators.
*
* The parameter \c T is the type of values.
*
......@@ -81,9 +81,9 @@ namespace mln
A2 a2_;
};
// FIXME: Doc!
/*!
* \brief Meta accumulator for pair.
*/
template <typename A1, typename A2>
struct pair : public Meta_Accumulator< pair<A1,A2> >
{
......
......@@ -48,7 +48,7 @@ namespace mln
{
/*! Generic sum accumulator class.
/*! \brief Generic sum accumulator class.
*
* Parameter \c T is the type of values that we sum. Parameter \c
* S is the type to store the value sum; the default type of
......@@ -78,7 +78,9 @@ namespace mln
struct sum_< util::pix<I>, S >;
// FIXME: Doc!
/*!
* \brief Meta accumulator for sum.
*/
struct sum : public Meta_Accumulator< sum >
{
template <typename T, typename S = mln_sum(T)>
......
......@@ -44,7 +44,7 @@ namespace mln
namespace accu
{
/*! Make an accumulator take the pixels of the image \p input.
/*! \brief Make an accumulator take the pixels of the image \p input.
*
* \param[in] input The input image.
* \param[in,out] a The accumulator.
......
......@@ -45,7 +45,8 @@ namespace mln
{
/*! Generic v of accumulators.
/*!
* \brief Generic val of accumulators.
*/
template <typename A>
struct val_ : public mln::accu::internal::base_< mln_result(A) , val_<A> >
......@@ -80,8 +81,9 @@ namespace mln
};
// FIXME: Doc!
/*!
* \brief Meta accumulator for val.
*/
template <typename mA>
struct val : public Meta_Accumulator< val<mA> >
{
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment