Commit 37a7c077 authored by Guillaume Lazzara's avatar Guillaume Lazzara
Browse files

Tag internal documentation.

	* apps/graph-morpho/morpho.hh,
	* mln/accu/internal/couple.hh,
	* mln/core/box_runend_piter.hh,
	* mln/core/box_runstart_piter.hh,
	* mln/core/concept/delta_point_site.hh,
	* mln/core/concept/dpoint.hh,
	* mln/core/concept/function.hh,
	* mln/core/concept/gdpoint.hh,
	* mln/core/concept/meta_accumulator.hh,
	* mln/core/concept/neighborhood.hh,
	* mln/core/concept/pseudo_site.hh,
	* mln/core/concept/site.hh,
	* mln/core/concept/site_proxy.hh,
	* mln/core/concept/site_set.hh,
	* mln/core/dpoints_pixter.hh,
	* mln/core/dpsites_piter.hh,
	* mln/core/image/ch_piter.hh,
	* mln/core/image/complex_image.hh,
	* mln/core/image/complex_neighborhood_piter.hh,
	* mln/core/image/complex_window_piter.hh,
	* mln/core/image/dmorph/extended.hh,
	* mln/core/image/dmorph/extension_fun.hh,
	* mln/core/image/dmorph/extension_ima.hh,
	* mln/core/image/dmorph/extension_val.hh,
	* mln/core/image/dmorph/hexa.hh,
	* mln/core/image/dmorph/hexa_piter.hh,
	* mln/core/image/dmorph/image2d_h.hh,
	* mln/core/image/dmorph/image_if.hh,
	* mln/core/image/dmorph/p2p_image.hh,
	* mln/core/image/dmorph/slice_image.hh,
	* mln/core/image/dmorph/sub_image.hh,
	* mln/core/image/dmorph/sub_image_if.hh,
	* mln/core/image/dmorph/transformed_image.hh,
	* mln/core/image/dmorph/unproject_image.hh,
	* mln/core/image/edge_image.hh,
	* mln/core/image/flat_image.hh,
	* mln/core/image/graph_window_if_piter.hh,
	* mln/core/image/graph_window_piter.hh,
	* mln/core/image/image1d.hh,
	* mln/core/image/image2d.hh,
	* mln/core/image/image3d.hh,
	* mln/core/image/imorph/decorated_image.hh,
	* mln/core/image/imorph/interpolated.hh,
	* mln/core/image/imorph/labeled_image.hh,
	* mln/core/image/imorph/lazy_image.hh,
	* mln/core/image/imorph/plain.hh,
	* mln/core/image/imorph/safe.hh,
	* mln/core/image/imorph/tr_image.hh,
	* mln/core/image/vertex_image.hh,
	* mln/core/image/vmorph/cast_image.hh,
	* mln/core/image/vmorph/fun_image.hh,
	* mln/core/image/vmorph/thru_image.hh,
	* mln/core/image/vmorph/violent_cast_image.hh,
	* mln/core/internal/box_impl.hh,
	* mln/core/internal/check/image_fastest.hh,
	* mln/core/internal/classical_window_base.hh,
	* mln/core/internal/complex_neighborhood_base.hh,
	* mln/core/internal/complex_window_base.hh,
	* mln/core/internal/complex_window_p_base.hh,
	* mln/core/internal/fixme.hh,
	* mln/core/internal/graph_psite_base.hh,
	* mln/core/internal/graph_window_base.hh,
	* mln/core/internal/image_base.hh,
	* mln/core/internal/image_domain_morpher.hh,
	* mln/core/internal/image_identity.hh,
	* mln/core/internal/image_morpher.hh,
	* mln/core/internal/image_primary.hh,
	* mln/core/internal/image_value_morpher.hh,
	* mln/core/internal/is_masked_impl_selector.hh,
	* mln/core/internal/labeled_image_base.hh,
	* mln/core/internal/morpher_lvalue.hh,
	* mln/core/internal/neighb_base.hh,
	* mln/core/internal/neighb_niter_base.hh,
	* mln/core/internal/neighb_niter_impl.hh,
	* mln/core/internal/neighborhood_base.hh,
	* mln/core/internal/piter_adaptor.hh,
	* mln/core/internal/piter_identity.hh,
	* mln/core/internal/pixel_impl.hh,
	* mln/core/internal/pixel_iterator_base.hh,
	* mln/core/internal/pseudo_site_base.hh,
	* mln/core/internal/run_image.hh,
	* mln/core/internal/set_of.hh,
	* mln/core/internal/site_relative_iterator_base.hh,
	* mln/core/internal/site_set_base.hh,
	* mln/core/internal/site_set_iterator_base.hh,
	* mln/core/internal/weighted_window_base.hh,
	* mln/core/internal/window_base.hh,
	* mln/core/pixter1d.hh,
	* mln/core/pixter2d.hh,
	* mln/core/pixter3d.hh,
	* mln/core/routine/ops.hh,
	* mln/core/site_set/attic/p_complex_faces_piter.hh,
	* mln/core/site_set/attic/p_faces_piter.hh,
	* mln/core/site_set/box_piter.hh,
	* mln/core/site_set/complex_psite.hh,
	* mln/core/site_set/p_array.hh,
	* mln/core/site_set/p_complex_piter.hh,
	* mln/core/site_set/p_edges_psite.hh,
	* mln/core/site_set/p_graph_piter.hh,
	* mln/core/site_set/p_if_piter.hh,
	* mln/core/site_set/p_n_faces_piter.hh,
	* mln/core/site_set/p_run_piter.hh,
	* mln/core/site_set/p_transformed_piter.hh,
	* mln/core/site_set/p_vertices_psite.hh,
	* mln/fun/c.hh,
	* mln/fun/internal/ch_function_value_impl.hh,
	* mln/fun/v2v/ch_function_value.hh,
	* mln/fun/x2x/composed.hh,
	* mln/geom/complex_geometry.hh,
	* mln/labeling/blobs.hh,
	* mln/labeling/blobs_and_compute.hh,
	* mln/metal/ands.hh,
	* mln/metal/bexpr.hh,
	* mln/metal/bool.hh,
	* mln/metal/converts_to.hh,
	* mln/metal/equal.hh,
	* mln/metal/goes_to.hh,
	* mln/metal/if.hh,
	* mln/metal/int.hh,
	* mln/metal/is.hh,
	* mln/metal/is_a.hh,
	* mln/metal/is_not.hh,
	* mln/metal/is_not_a.hh,
	* mln/pw/image.hh,
	* mln/pw/internal/image_base.hh,
	* mln/topo/adj_higher_dim_connected_n_face_iter.hh,
	* mln/topo/adj_higher_face_iter.hh,
	* mln/topo/adj_lower_dim_connected_n_face_iter.hh,
	* mln/topo/adj_lower_face_iter.hh,
	* mln/topo/adj_lower_higher_face_iter.hh,
	* mln/topo/adj_m_face_iter.hh,
	* mln/topo/attic/faces_iter.hh,
	* mln/topo/center_only_iter.hh,
	* mln/topo/centered_iter_adapter.hh,
	* mln/topo/complex.hh,
	* mln/topo/face_data.hh,
	* mln/topo/face_iter.hh,
	* mln/topo/internal/complex_iterator_base.hh,
	* mln/topo/internal/complex_relative_iterator_base.hh,
	* mln/topo/internal/complex_relative_iterator_sequence.hh,
	* mln/topo/internal/complex_set_iterator_base.hh,
	* mln/topo/n_face_iter.hh,
	* mln/topo/static_n_face_iter.hh,
	* mln/trait/ch_function_value.hh,
	* mln/trait/image/props.hh,
	* mln/trait/images.hh,
	* mln/trait/neighborhood.hh,
	* mln/trait/promote.hh,
	* mln/trait/site_set/props.hh,
	* mln/trait/site_sets.hh,
	* mln/trait/solve.hh,
	* mln/trait/window/props.hh,
	* mln/trait/windows.hh,
	* mln/util/branch_iter.hh,
	* mln/util/branch_iter_ind.hh,
	* mln/util/edge.hh,
	* mln/util/graph.hh,
	* mln/util/internal/edge_impl.hh,
	* mln/util/internal/graph_base.hh,
	* mln/util/internal/graph_iter.hh,
	* mln/util/internal/vertex_impl.hh,
	* mln/util/lemmings.hh,
	* mln/util/line_graph.hh,
	* mln/util/site_pair.hh,
	* mln/util/vertex.hh,
	* mln/value/internal/value_like.hh,
	* mln/value/viter.hh: Add \internal tag.
parent 4d3fb09e
2013-03-08 Guillaume Lazzara <z@lrde.epita.fr>
Tag internal documentation.
* apps/graph-morpho/morpho.hh,
* mln/accu/internal/couple.hh,
* mln/core/box_runend_piter.hh,
* mln/core/box_runstart_piter.hh,
* mln/core/concept/delta_point_site.hh,
* mln/core/concept/dpoint.hh,
* mln/core/concept/function.hh,
* mln/core/concept/gdpoint.hh,
* mln/core/concept/meta_accumulator.hh,
* mln/core/concept/neighborhood.hh,
* mln/core/concept/pseudo_site.hh,
* mln/core/concept/site.hh,
* mln/core/concept/site_proxy.hh,
* mln/core/concept/site_set.hh,
* mln/core/dpoints_pixter.hh,
* mln/core/dpsites_piter.hh,
* mln/core/image/ch_piter.hh,
* mln/core/image/complex_image.hh,
* mln/core/image/complex_neighborhood_piter.hh,
* mln/core/image/complex_window_piter.hh,
* mln/core/image/dmorph/extended.hh,
* mln/core/image/dmorph/extension_fun.hh,
* mln/core/image/dmorph/extension_ima.hh,
* mln/core/image/dmorph/extension_val.hh,
* mln/core/image/dmorph/hexa.hh,
* mln/core/image/dmorph/hexa_piter.hh,
* mln/core/image/dmorph/image2d_h.hh,
* mln/core/image/dmorph/image_if.hh,
* mln/core/image/dmorph/p2p_image.hh,
* mln/core/image/dmorph/slice_image.hh,
* mln/core/image/dmorph/sub_image.hh,
* mln/core/image/dmorph/sub_image_if.hh,
* mln/core/image/dmorph/transformed_image.hh,
* mln/core/image/dmorph/unproject_image.hh,
* mln/core/image/edge_image.hh,
* mln/core/image/flat_image.hh,
* mln/core/image/graph_window_if_piter.hh,
* mln/core/image/graph_window_piter.hh,
* mln/core/image/image1d.hh,
* mln/core/image/image2d.hh,
* mln/core/image/image3d.hh,
* mln/core/image/imorph/decorated_image.hh,
* mln/core/image/imorph/interpolated.hh,
* mln/core/image/imorph/labeled_image.hh,
* mln/core/image/imorph/lazy_image.hh,
* mln/core/image/imorph/plain.hh,
* mln/core/image/imorph/safe.hh,
* mln/core/image/imorph/tr_image.hh,
* mln/core/image/vertex_image.hh,
* mln/core/image/vmorph/cast_image.hh,
* mln/core/image/vmorph/fun_image.hh,
* mln/core/image/vmorph/thru_image.hh,
* mln/core/image/vmorph/violent_cast_image.hh,
* mln/core/internal/box_impl.hh,
* mln/core/internal/check/image_fastest.hh,
* mln/core/internal/classical_window_base.hh,
* mln/core/internal/complex_neighborhood_base.hh,
* mln/core/internal/complex_window_base.hh,
* mln/core/internal/complex_window_p_base.hh,
* mln/core/internal/fixme.hh,
* mln/core/internal/graph_psite_base.hh,
* mln/core/internal/graph_window_base.hh,
* mln/core/internal/image_base.hh,
* mln/core/internal/image_domain_morpher.hh,
* mln/core/internal/image_identity.hh,
* mln/core/internal/image_morpher.hh,
* mln/core/internal/image_primary.hh,
* mln/core/internal/image_value_morpher.hh,
* mln/core/internal/is_masked_impl_selector.hh,
* mln/core/internal/labeled_image_base.hh,
* mln/core/internal/morpher_lvalue.hh,
* mln/core/internal/neighb_base.hh,
* mln/core/internal/neighb_niter_base.hh,
* mln/core/internal/neighb_niter_impl.hh,
* mln/core/internal/neighborhood_base.hh,
* mln/core/internal/piter_adaptor.hh,
* mln/core/internal/piter_identity.hh,
* mln/core/internal/pixel_impl.hh,
* mln/core/internal/pixel_iterator_base.hh,
* mln/core/internal/pseudo_site_base.hh,
* mln/core/internal/run_image.hh,
* mln/core/internal/set_of.hh,
* mln/core/internal/site_relative_iterator_base.hh,
* mln/core/internal/site_set_base.hh,
* mln/core/internal/site_set_iterator_base.hh,
* mln/core/internal/weighted_window_base.hh,
* mln/core/internal/window_base.hh,
* mln/core/pixter1d.hh,
* mln/core/pixter2d.hh,
* mln/core/pixter3d.hh,
* mln/core/routine/ops.hh,
* mln/core/site_set/attic/p_complex_faces_piter.hh,
* mln/core/site_set/attic/p_faces_piter.hh,
* mln/core/site_set/box_piter.hh,
* mln/core/site_set/complex_psite.hh,
* mln/core/site_set/p_array.hh,
* mln/core/site_set/p_complex_piter.hh,
* mln/core/site_set/p_edges_psite.hh,
* mln/core/site_set/p_graph_piter.hh,
* mln/core/site_set/p_if_piter.hh,
* mln/core/site_set/p_n_faces_piter.hh,
* mln/core/site_set/p_run_piter.hh,
* mln/core/site_set/p_transformed_piter.hh,
* mln/core/site_set/p_vertices_psite.hh,
* mln/fun/c.hh,
* mln/fun/internal/ch_function_value_impl.hh,
* mln/fun/v2v/ch_function_value.hh,
* mln/fun/x2x/composed.hh,
* mln/geom/complex_geometry.hh,
* mln/labeling/blobs.hh,
* mln/labeling/blobs_and_compute.hh,
* mln/metal/ands.hh,
* mln/metal/bexpr.hh,
* mln/metal/bool.hh,
* mln/metal/converts_to.hh,
* mln/metal/equal.hh,
* mln/metal/goes_to.hh,
* mln/metal/if.hh,
* mln/metal/int.hh,
* mln/metal/is.hh,
* mln/metal/is_a.hh,
* mln/metal/is_not.hh,
* mln/metal/is_not_a.hh,
* mln/pw/image.hh,
* mln/pw/internal/image_base.hh,
* mln/topo/adj_higher_dim_connected_n_face_iter.hh,
* mln/topo/adj_higher_face_iter.hh,
* mln/topo/adj_lower_dim_connected_n_face_iter.hh,
* mln/topo/adj_lower_face_iter.hh,
* mln/topo/adj_lower_higher_face_iter.hh,
* mln/topo/adj_m_face_iter.hh,
* mln/topo/attic/faces_iter.hh,
* mln/topo/center_only_iter.hh,
* mln/topo/centered_iter_adapter.hh,
* mln/topo/complex.hh,
* mln/topo/face_data.hh,
* mln/topo/face_iter.hh,
* mln/topo/internal/complex_iterator_base.hh,
* mln/topo/internal/complex_relative_iterator_base.hh,
* mln/topo/internal/complex_relative_iterator_sequence.hh,
* mln/topo/internal/complex_set_iterator_base.hh,
* mln/topo/n_face_iter.hh,
* mln/topo/static_n_face_iter.hh,
* mln/trait/ch_function_value.hh,
* mln/trait/image/props.hh,
* mln/trait/images.hh,
* mln/trait/neighborhood.hh,
* mln/trait/promote.hh,
* mln/trait/site_set/props.hh,
* mln/trait/site_sets.hh,
* mln/trait/solve.hh,
* mln/trait/window/props.hh,
* mln/trait/windows.hh,
* mln/util/branch_iter.hh,
* mln/util/branch_iter_ind.hh,
* mln/util/edge.hh,
* mln/util/graph.hh,
* mln/util/internal/edge_impl.hh,
* mln/util/internal/graph_base.hh,
* mln/util/internal/graph_iter.hh,
* mln/util/internal/vertex_impl.hh,
* mln/util/lemmings.hh,
* mln/util/line_graph.hh,
* mln/util/site_pair.hh,
* mln/util/vertex.hh,
* mln/value/internal/value_like.hh,
* mln/value/viter.hh: Add \internal tag.
2013-03-08 Guillaume Lazzara <z@lrde.epita.fr>
 
* mln/core/internal/image_base.hh: Set documentation as internal.
// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE)
// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory
// (LRDE)
//
// This file is part of Olena.
//
......@@ -68,7 +69,10 @@
namespace trait
{
/// Graph traits.
/*!
\internal
\brief Graph traits.
*/
template <typename I>
struct graph
{
......@@ -89,7 +93,10 @@ namespace trait
// Graph traits for (mln::image2d-based) cubical 2-complexes. //
// ----------------------------------------------------------- //
/// Graph traits for mln::image2d.
/*!
\internal
\brief Graph traits for mln::image2d.
*/
template <typename T>
struct graph< mln::image2d<T> >
{
......@@ -128,7 +135,10 @@ namespace trait
// Graph traits for (general) 1-complexes. //
// ---------------------------------------- //
/// Graph traits for 1-complexes images.
/*!
\internal
\brief Graph traits for 1-complexes images.
*/
template <typename G, typename V>
struct graph< mln::complex_image<1, G, V> >
{
......
// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE)
// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory
// (LRDE)
//
// This file is part of Olena.
//
......@@ -47,11 +48,14 @@ namespace mln
namespace internal
{
/// Base implementation of a couple of accumulators.
///
/// The parameter \c T is the type of values.
///
/// \todo Check that, when T is not provided, A1 and A2 have the same value.
/*!
\internal
\brief Base implementation of a couple of accumulators.
The parameter \c T is the type of values.
\todo Check that, when T is not provided, A1 and A2 have the same value.
*/
template <typename A1, typename A2, typename R, typename E>
class couple
: public base<R,E>,
......
// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE)
// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory
// (LRDE)
//
// This file is part of Olena.
//
......@@ -41,10 +42,12 @@
namespace mln
{
/*! \brief A generic backward iterator on points by lines.
*
* The parameter \c P is the type of points.
*/
/*!
\internal
\brief A generic backward iterator on points by lines.
The parameter \c P is the type of points.
*/
template <typename P>
class box_runend_piter :
public internal::site_set_iterator_base< box<P>,
......
// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE)
// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
//
......@@ -41,10 +42,12 @@
namespace mln
{
/*! \brief A generic forward iterator on points by lines.
*
* The parameter \c P is the type of points.
*/
/*!
\internal
\brief A generic forward iterator on points by lines.
The parameter \c P is the type of points.
*/
template <typename P>
class box_runstart_piter :
public internal::site_set_iterator_base< box<P>,
......
// Copyright (C) 2007, 2009 EPITA Research and Development Laboratory (LRDE)
// Copyright (C) 2007, 2009, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
//
......@@ -65,7 +66,10 @@ namespace mln
/// Delta point site category flag type.
/*!
\internal
\brief Delta point site category flag type.
*/
template <>
struct Delta_Point_Site<void>
{
......@@ -73,8 +77,10 @@ namespace mln
};
/*! \brief FIXME: Doc!
*/
/*!
\internal
\brief FIXME: Doc!
*/
template <typename E>
struct Delta_Point_Site : public Object<E>
{
......@@ -101,7 +107,7 @@ namespace mln
// Operators.
template <typename D>
std::ostream&
std::ostream&
operator<<(std::ostream& ostr, const Delta_Point_Site<D>& dp);
......
// Copyright (C) 2007, 2009 EPITA Research and Development Laboratory (LRDE)
// Copyright (C) 2007, 2009, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
//
......@@ -49,16 +50,18 @@ namespace mln
};
/*! \brief Base class for implementation of delta-point classes.
*
* A delta-point is a vector defined by a couple of points.
*
* Given two points, A and B, the vector AB is mapped into the
* delta-point D = AB. Practically one can write: D = B - A.
*
* \see mln::doc::Dpoint for a complete documentation of this class
* contents.
*/
/*!
\internal
\brief Base class for implementation of delta-point classes.
A delta-point is a vector defined by a couple of points.
Given two points, A and B, the vector AB is mapped into the
delta-point D = AB. Practically one can write: D = B - A.
\see mln::doc::Dpoint for a complete documentation of this class
contents.
*/
template <typename E>
struct Dpoint : public Delta_Point_Site<E>
{
......
// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development
// Laboratory (LRDE)
// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and
// Development Laboratory (LRDE)
//
// This file is part of Olena.
//
......@@ -46,7 +46,10 @@ namespace mln
template <typename E> struct Function_vv2b;
/// Function category flag type.
/*!
\internal
\brief Function category flag type.
*/
template <>
struct Function<void>
{
......
......@@ -83,7 +83,10 @@ namespace mln
/// Delta point site category flag type.
/*!
\internal
\brief Delta point site category flag type.
*/
template <>
struct Gdpoint<void>
{
......
// Copyright (C) 2007, 2008, 2009 EPITA Research and Development
// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
......@@ -62,9 +62,11 @@ namespace mln
namespace internal
{
/// Make the type resolution easier for the compiler.
/// Introduced for ICC compatibility.
//
/*!
\internal
\brief Make the type resolution easier for the compiler.
Introduced for ICC compatibility.
*/
template <typename A, typename T>
struct meta_accu_ret_result_helper
{
......@@ -72,9 +74,11 @@ namespace mln
};
/// Make the type resolution easier for the compiler.
/// Introduced for ICC compatibility.
//
/*!
\internal
\brief Make the type resolution easier for the compiler.
Introduced for ICC compatibility.
*/
template <typename A, typename T>
struct accu_with_helper
{
......@@ -92,12 +96,14 @@ namespace mln
typedef Object<void> super;
};
/*! \brief Base class for implementation of meta accumulators.
*
* The parameter \a E is the exact type.
*
* \see mln::doc::Meta_Accumulator for a complete documentation of
* this class contents.
/*!
\internal
\brief Base class for implementation of meta accumulators.
The parameter \a E is the exact type.
\see mln::doc::Meta_Accumulator for a complete documentation of
this class contents.
*/
template <typename E>
struct Meta_Accumulator : public Object<E>
......
// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development
// Laboratory (LRDE)
// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and
// Development Laboratory (LRDE)
//
// This file is part of Olena.
//
......@@ -49,8 +49,10 @@ namespace mln
template <typename E> struct Neighborhood;
/// Neighborhood category flag type.
/*!
\internal
\brief Neighborhood category flag type.
*/
template <>
struct Neighborhood<void>
{
......
// Copyright (C) 2008, 2009, 2011 EPITA Research and Development
// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
......@@ -48,7 +48,10 @@ namespace mln
/// Pseudo_Site category flag type.
/*!
\internal
\brief Pseudo_Site category flag type.
*/
template <>
struct Pseudo_Site<void>
{
......@@ -125,7 +128,7 @@ namespace mln
template <>
struct helper< /* is an Object */ true >
{
template <typename P>
void change_target(Pseudo_Site<P>& p,
const mln_target(P)& new_target) const
......@@ -138,7 +141,7 @@ namespace mln
{
// No-op.
}
};
template <>
......@@ -150,7 +153,7 @@ namespace mln
// No-op.
}
};
} // namespace mln::if_possible::internal
......
// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE)
// Copyright (C) 2008, 2009, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
//
......@@ -41,7 +42,10 @@ namespace mln
template <typename E> struct Site;
/// Site category flag type.
/*!
\internal
\brief Site category flag type.
*/
template <>
struct Site<void>
{
......
// Copyright (C) 2008, 2009, 2011 EPITA Research and Development
// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
......@@ -45,7 +45,10 @@ namespace mln
template <typename E> struct Site_Proxy;
/// Site_Proxy category flag type.
/*!
\internal
\brief Site_Proxy category flag type.
*/
template <>
struct Site_Proxy<void>
{
......
......@@ -50,7 +50,10 @@ namespace mln
template <typename E> struct Site_Set;
/// Site_Set category flag type.
/*!
\internal
\brief Site_Set category flag type.
*/
template <>
struct Site_Set<void>
{
......@@ -58,10 +61,12 @@ namespace mln
};
/// Base class for implementation classes of site sets.
///
/// \see mln::doc::Site_Set for a complete documentation of this
/// class contents.
/*!
\brief Base class for implementation classes of site sets.
\see mln::doc::Site_Set for a complete documentation of this
class contents.
*/
template <typename E>
struct Site_Set : public Object<E>
{
......
......@@ -50,10 +50,13 @@ namespace mln
| dpoints_fwd_pixter<I>. |
`------------------------*/
/// \brief A generic forward iterator on the pixels of a
/// dpoint-based window or neighborhood.
///
/// Parameter \c I is the image type.
/*!
\internal
\brief A generic forward iterator on the pixels of a
dpoint-based window or neighborhood.
Parameter \c I is the image type.
*/
template <typename I>
class dpoints_fwd_pixter
: public Pixel_Iterator< dpoints_fwd_pixter<I> >,
......@@ -133,10 +136,13 @@ namespace mln
| dpoints_bkd_pixter<I>. |
`------------------------*/
/// \brief A generic backward iterator on the pixels of a
/// dpoint-based window or neighborhood.
///
/// Parameter \c I is the image type.
/*!
\internal
\brief A generic backward iterator on the pixels of a
dpoint-based window or neighborhood.
Parameter \c I is the image type.
*/
template <typename I>
class dpoints_bkd_pixter
: public Pixel_Iterator< dpoints_bkd_pixter<I> >,
......
// Copyright (C) 2007, 2008, 2009 EPITA Research and Development
// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
......@@ -39,11 +39,14 @@
namespace mln
{
/// A generic forward iterator on points of windows and of
/// neighborhoods.
///
/// The parameter \c V is the type of std::vector enclosing
/// structure.
/*!
\internal