[gedit] docs - wrote documentation for the Code Comment plugin



commit d888ed42b53dc357653542a5b199d7282ac1ad9f
Author: Jim Campbell <jwcampbell gmail com>
Date:   Mon Oct 24 22:31:10 2011 -0500

    docs - wrote documentation for the Code Comment plugin

 help/C/gedit-plugins-code-comment.page      |   45 +++++++++++++++++++++++++++
 help/C/gedit-plugins-code-comment.page.stub |   31 ------------------
 2 files changed, 45 insertions(+), 31 deletions(-)
---
diff --git a/help/C/gedit-plugins-code-comment.page b/help/C/gedit-plugins-code-comment.page
new file mode 100644
index 0000000..b2d550f
--- /dev/null
+++ b/help/C/gedit-plugins-code-comment.page
@@ -0,0 +1,45 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="gedit-plugins-code-comment">
+  <info>
+    <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>  
+    <revision version="3.4" date="2011-10-23" status="candidate"/>
+
+    <credit type="author">
+      <name>Jim Campbell</name>
+      <email>jwcampbell gmail com</email>
+    </credit>
+
+    <desc>Comment-out or uncomment a block of code</desc>
+  </info>
+
+  <title>Code comment</title>
+
+  <p>Code comments are portions of text that make it easier for people to 
+  understand a program's code, but they don't affect how a program works. 
+  Comments are separated from other parts of a program by special characters.
+  </p>
+  
+  <p>The <app>code comment</app> plugin makes it easier to quickly create or 
+  remove code comments. To enable the code comment plugin, select <guiseq><gui>
+  Edit</gui><gui> Preferences</gui><gui>Plugins</gui><gui>Code comment</gui>
+  </guiseq>.</p>
+  
+  <p>To create or remove a comment:</p>
+  <steps>
+    <item><p>Highlight the portion of text where you want to add or remove
+    a comment.</p></item>
+    <item><p>To add a comment, click <guiseq><gui>Edit</gui><gui>Comment Code
+    </gui></guiseq>, or press <keyseq><key>Ctrl</key><key>M</key></keyseq>.</p>
+    </item>
+    <item><p>To remove a comment, click <guiseq><gui>Edit</gui><gui>Uncomment 
+    Code</gui></guiseq>, or press <keyseq><key>Shift</key><key>Ctrl</key>
+    <key>M</key></keyseq>.</p></item>
+  </steps>
+  
+  <note style="tip"><p><app>Gedit</app> will automatically use the correct 
+  style of comment based on the language or syntax of the file. If <app>gedit
+  </app> doesn't identify your language or syntax, you can select it from
+  the language list in the bottom <gui>Status bar</gui>.</p></note>
+
+</page>



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]