Add GTK bibitem dialog

[lyx.git] / src / paragraph_funcs.h

diff --git a/src/paragraph_funcs.h b/src/paragraph_funcs.h
index 7bf37146d913007c9fc760ab40998ed44b573d50..3686b36c8429da962807f522ca8bcc50b02bcad1 100644 (file)
--- a/src/paragraph_funcs.h
+++ b/src/paragraph_funcs.h
@@ -21,8 +21,15 @@ class LyXFont;
 class Paragraph;
 class ParagraphList;
 
-
-///
+/**
+ * This breaks a paragraph at the specified position.
+ * The new paragraph will:
+ * get the default layout, when flag == 0
+ * will inherit the existing one, except for depth, when flag == 1
+ * will inherit the existing one, including depth, when flag == 2
+ * Be aware that the old or new paragraph does not contain any rows
+ * after this.
+ */
 void breakParagraph(BufferParams const & bparams,
                    ParagraphList & paragraphs,
                    lyx::pit_type par,