#270: Properly use Doxygen grouping commands
----------------------+------------------------
Reporter: levill_r | Owner: Olena Team
Type: defect | Status: new
Priority: minor | Milestone:
Component: Milena | Version: 1.0
Keywords: doc |
----------------------+------------------------
Ensure the following style is used uniformly in Olena when documentation
grouping is required:
{{{
/// \name Code generation.
/// \{
/* ... */
/// \}
}}}
Do not omit the `\name` keyword!
--
Ticket URL: <https://trac.lrde.epita.fr/olena/ticket/270>
Olena <http://olena.lrde.epita.fr>
Olena, a software platform dedicated to image processing.
---
scribo/ChangeLog | 4 ++++
scribo/scribo/primitive/extract/alignments.hh | 8 ++++----
2 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/scribo/ChangeLog b/scribo/ChangeLog
index e9ab8d1..1f254cb 100644
--- a/scribo/ChangeLog
+++ b/scribo/ChangeLog
@@ -1,3 +1,7 @@
+2013-08-22 Roland Levillain <roland(a)lrde.epita.fr>
+
+ * scribo/primitive/extract/alignments.hh: Fix Doxygen comments.
+
2013-07-31 Roland Levillain <roland(a)lrde.epita.fr>
Fix the distribution of Scribo.
diff --git a/scribo/scribo/primitive/extract/alignments.hh b/scribo/scribo/primitive/extract/alignments.hh
index 7bd9b94..c06880b 100644
--- a/scribo/scribo/primitive/extract/alignments.hh
+++ b/scribo/scribo/primitive/extract/alignments.hh
@@ -92,17 +92,17 @@ namespace scribo
\pre Separators should be removed from input document image .
- \pre Text in \p doc must be constructed from Components
+ \pre Text in \p doc must be constructed from components
grouped by lines with a very strict criterion in order to keep
spaces between words and paragraphs. This first grouping is
necessary to avoid false positive (e.g. inside the text
blocks).
- \pre \p doc must have text (has_text() returns true).
+ \pre \p doc must have text (doc.has_text() returns true).
- Internal description :
- ----------------------
+ Internal description:
+ ---------------------
1) Build an image of line bboxes
2) For TOP and BOTTOM
--
1.7.10.4
---
scribo/ChangeLog | 4 ++++
scribo/scribo/primitive/extract/alignments.hh | 8 ++++----
2 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/scribo/ChangeLog b/scribo/ChangeLog
index e9ab8d1..1f254cb 100644
--- a/scribo/ChangeLog
+++ b/scribo/ChangeLog
@@ -1,3 +1,7 @@
+2013-08-22 Roland Levillain <roland(a)lrde.epita.fr>
+
+ * scribo/primitive/extract/alignments.hh: Fix Doxygen comments.
+
2013-07-31 Roland Levillain <roland(a)lrde.epita.fr>
Fix the distribution of Scribo.
diff --git a/scribo/scribo/primitive/extract/alignments.hh b/scribo/scribo/primitive/extract/alignments.hh
index 7bd9b94..c06880b 100644
--- a/scribo/scribo/primitive/extract/alignments.hh
+++ b/scribo/scribo/primitive/extract/alignments.hh
@@ -92,17 +92,17 @@ namespace scribo
\pre Separators should be removed from input document image .
- \pre Text in \p doc must be constructed from Components
+ \pre Text in \p doc must be constructed from components
grouped by lines with a very strict criterion in order to keep
spaces between words and paragraphs. This first grouping is
necessary to avoid false positive (e.g. inside the text
blocks).
- \pre \p doc must have text (has_text() returns true).
+ \pre \p doc must have text (doc.has_text() returns true).
- Internal description :
- ----------------------
+ Internal description:
+ ---------------------
1) Build an image of line bboxes
2) For TOP and BOTTOM
--
1.7.10.4