Git commit b2c5bd5c7efd29d7ddd3adfdef84bcf92ce64930 by Burkhard L?ck. Committed on 23/11/2013 at 21:49. Pushed by lueck into branch 'master'.
bugs are fixed, no need to mention them in the documentation M +5 -5 doc/kdevelop/index.docbook http://commits.kde.org/kdevelop/b2c5bd5c7efd29d7ddd3adfdef84bcf92ce64930 diff --git a/doc/kdevelop/index.docbook b/doc/kdevelop/index.docbook index d2b7257..a5e5f36 100644 --- a/doc/kdevelop/index.docbook +++ b/doc/kdevelop/index.docbook @@ -159,7 +159,8 @@ double bar () </mediaobject> </screenshot></para> <para>In order to work with projects, &kdevelop; has the concept of <emphasis>tools</emphasis>. A tool provides a particular view of the source, or an action that can be taken with it. Tools are represented by buttons around the perimeter of your window (in vertical text along the left and right margins, or horizontally along the bottom margin). If you click on them, they expand to a subwindow — a <emphasis>view</emphasis> — within the main window; if you click on the tool button again, the subwindow disappears again.</para> -<para><note><para>To make a subwindow disappear, you can also click at the <guilabel>x</guilabel> at the top right of the subwindow; however, at least with &kdevelop; 4.2.x, this also removes the button representing the tool from the perimeter, which was your way of getting the subwindow back. See below for how to get the button back onto the perimeter in the same way as getting any tool's button there. This behavior has been reported as <ulink url="http://bugs.kde.org/show_bug.cgi?id=270018";>bug 270018</ulink></para></note></para> +<para>To make a subwindow disappear, you can also click at the <guilabel>x</guilabel> at the top right of the subwindow</para> +<!--FIXME How to add a tool--> <para>The picture above shows a particular selection of tools, aligned on the left and right margins; in the picture, the <guilabel>Classes</guilabel> tool is open on the left and the <guilabel>Snippets</guilabel> tool on the right, along with an editor for a source file in the middle. In practice, most of the time you will probably only have the editor and maybe the <guilabel>Classes</guilabel> or <guilabel>Code Browser</guilabel> tool open at the left. Other tool view will likely only be open temporarily as you use the tool, leaving more space for the editor most of the time.</para> <para>When you run &kdevelop; the first time, you should already have the <guilabel>Projects</guilabel> tool button. Click on it: it will open a subwindow that shows the projects you have added to the session at the bottom, and a file system view of the directories of your projects at the top.</para> <para>There are many other tools you can use with &kdevelop;, not all of which are initially present as buttons on the perimeter. To add some, go to the <menuchoice><guimenu>Windows</guimenu><guimenuitem>Add tool view</guimenuitem></menuchoice> menu entry. Here are some that you will likely find useful:</para> @@ -631,8 +632,7 @@ void foo() </caption> </mediaobject> </screenshot></para> -<para><note><para>The fact that the tooltip shows the same function twice is fixed in &kdevelop; 4.2.2 and later.</para></note></para> -<para><note><para>In the example, accepting one of the choices the auto-completion tool offers yields the correct signature but unfortunately deletes the <varname>inline</varname> marker already written. This has been reported as <ulink url="https://bugs.kde.org/show_bug.cgi?id=274244";>&kdevelop; Bug 274245</ulink>.</para></note></para> +<para><note><para>In the example, accepting one of the choices the auto-completion tool offers yields the correct signature but unfortunately deletes the <varname>inline</varname> marker already written. This has been reported as <ulink url="https://bugs.kde.org/show_bug.cgi?id=274245";>&kdevelop; Bug 274245</ulink>.</para></note></para> </sect2> <sect2 id="documenting-declarations"><title>Documenting declarations</title> <para>Good code is well documented, both at the level of the implementation of algorithms within in functions as well as at the level of the interface — &ie;, classes, (member and global) functions, and (member or global) variables need to be documented to explain their intent, possible values of arguments, pre- and postconditions, &etc; As far as documenting the interface is concerned, <ulink url="http://www.doxygen.org";>doxygen</ulink> has become the de facto standard for formatting comments that can then be extracted and displayed on searchable webpages.</para> @@ -777,7 +777,7 @@ for (typename Triangulation::active_cell_iterator </caption> </mediaobject> </screenshot></para> -<para><note><para>The name of a snippet may not have spaces or other special characters because it must look like a normal function or variable name (for reasons that will become clear in the next paragraph). If the name of the snippet does contain spaces, the <guilabel>OK</guilabel> button will become inactive without any further explanation. This has been reported as <ulink url="https://bugs.kde.org/show_bug.cgi?id=274299";>&kdevelop; bug 274299</ulink>.</para></note></para> +<para><note><para>The name of a snippet may not have spaces or other special characters because it must look like a normal function or variable name (for reasons that will become clear in the next paragraph).</para></note></para> <para>To use a snippet so defined, when you are editing code, you can just type the name of the snippet like you would any other function or variable name. This name will become available for auto-completion — which means that there is no harm in using a long and descriptive name for a snippet such as the one above — and when you accept the suggestion of the auto-completion tooltip (for example by just hitting &Enter;), the already entered part of the snippets' name will be replaced by the full expansion of the snippet and will be properly indented:</para> <para> <screenshot> @@ -1193,7 +1193,7 @@ template into &kdevelop; by opening the template manager, activating the appropr </mediaobject> </screenshot></para> <para>You can now try to run the program: Select <menuchoice><guimenu>Run</guimenu><guimenuitem>Execute Launch</guimenuitem></menuchoice> from &kdevelop;'s main window menu (or hit <keycombo>&Shift;<keycap>F9</keycap></keycombo>) and your program should run in a separate subwindow of &kdevelop;. The picture above shows the result: The new <guilabel>Run</guilabel> tool subwindow at the bottom shows the output of the program that is being run, in this case of the <replaceable>step-32</replaceable> program.</para> -<para><note><para> If you have configured multiple launches, you can choose which one should run when you hit <keycombo>&Shift;<keycap>F9</keycap></keycombo> by going to <menuchoice><guimenu>Run</guimenu><guimenuitem>Current Launch Configuration</guimenuitem></menuchoice>. Unfortunately, by default, all launches are named <emphasis>New Native Application</emphasis> without an <emphasis>obvious</emphasis> possibility of renaming them, making it difficult to distinguish them when selecting the current launch configuration (see <ulink url="https://bugs.kde.org/show_bug.cgi?id=272300";>&kdevelop; bug 272300</ulink>). There is a non-obvious way to edit the name of a configuration, however: in the dialog box you get when you select <menuchoice><guimenu>Run</guimenu><guimenuitem>Current Launch Configuration</guimenuitem></menuchoice>, double-click on the name of the configuration in the tree view on the left, which will allow you to edit the configuration's name.</para></note></para> +<para><note><para> If you have configured multiple launches, you can choose which one should run when you hit <keycombo>&Shift;<keycap>F9</keycap></keycombo> by going to <menuchoice><guimenu>Run</guimenu><guimenuitem>Current Launch Configuration</guimenuitem></menuchoice>. There is a non-obvious way to edit the name of a configuration, however: in the dialog box you get when you select <menuchoice><guimenu>Run</guimenu><guimenuitem>Current Launch Configuration</guimenuitem></menuchoice>, double-click on the name of the configuration in the tree view on the left, which will allow you to edit the configuration's name.</para></note></para> </sect1> <sect1 id="some-useful-keyboard-shortcuts0"><title>Some useful keyboard shortcuts</title> <para>
