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     <desc>
  10       Quickly find the information you need in the API documentation
  11     </desc>
  12
  13     <credit type="author">
  14       <name>Johannes Schmid</name>
  15       <email>jhs@gnome.org</email>
  16     </credit>
  17   </info>
  18
  19   <title>Using the API reference</title>
  20
  21 <section>
  22 <title>Browsing the API reference</title>
  23
  24 <p>For a quick access to the API reference of libraries, anjuta features an
  25 integrated API browser. If not already done it can be activated in the preferences
  26 (<guiseq><gui>Edit</gui><gui>Preferences</gui></guiseq>) in
  27 <guiseq><gui>General</gui><gui>Plugins</gui></guiseq> by choosing the
  28 <app>DevHelp</app> plugin.</p>
  29
  30 <p>The API reference has two windows, one for searching for a specific symbol
  31 and the browser for viewing the help documents.</p>
  32
  33 </section>
  34
  35 <section>
  36 <title>Jump to the API reference using shortcuts in the editor</title>
  37
  38 <p>In case you are unsure how a specific function used in existing code works,
  39 simply place the cursor on the function name and use
  40 <keyseq><key>Shift</key><key>F1</key></keyseq> (or
  41 <guiseq><gui>Help</gui><gui>Context-Help</gui></guiseq>) to jump to the documentation.
  42 </p>
  43
  44 </section>
  45
  46 </page>