manuals/anjuta-manual/C/anjuta-code-help.page

   1 <page xmlns="http://projectmallard.org/1.0/"
   2       type="topic" style="task"
   3       id="anjuta-code-help">
   4
   5   <info xmlns:facet="http://projectmallard.org/facet/1.0/">
   6     <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
   7     <link type="guide" xref="index#anjuta-code" group="first"/>
   8     <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
   9     <credit type="author">
  10       <name>Johannes Schmid</name>
  11       <email>jhs@gnome.org</email>
  12     </credit>
  13   </info>
  14
  15   <title>Using the API reference</title>
  16
  17 <section>
  18 <title>Browsing the API reference</title>
  19
  20 <p>For a quick access to the API reference of libraries, anjuta features an
  21 integrated API browser. If not already done it can be activated in the preferences
  22 (<guiseq><gui>Edit</gui><gui>Preferences</gui></guiseq>) in
  23 <guiseq><gui>General</gui><gui>Plugins</gui></guiseq> by choosing the
  24 <app>DevHelp</app> plugin.</p>
  25
  26 <p>The API reference has two windows, one for searching for a specific symbol
  27 and the browser for viewing the help documents.</p>
  28
  29 </section>
  30
  31 <section>
  32 <title>Jump to the API reference using shortcuts in the editor</title>
  33
  34 <p>In case you are unsure how a specific function used in existing code works,
  35 simply place the cursor on the function name and use
  36 <keyseq><key>Shift</key><key>F1</key></keyseq> (or
  37 <guiseq><gui>Help</gui><gui>Context-Help</gui></guiseq>) to jump to the documentation.
  38 </p>
  39
  40 </section>
  41
  42 </page>