1
<?xml version="1.0" encoding="utf-8"?>
2
<page xmlns="http://projectmallard.org/1.0/" xmlns:its="http://www.w3.org/2005/11/its" type="topic" style="task" id="plugin-code-assistance" xml:lang="zh-HK">
5
<link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
6
<revision version="3.4" date="2013-02-24" status="review"/>
9
<name>Jim Campbell</name>
10
<email its:translate="no">jwcampbell@gmail.com</email>
13
<desc>Real-time error highlighting for supported languages.</desc>
16
<title>Code Assistance</title>
18
<!-- NOTE: This is draft documentation. It is not yet ready for translation.
21
<p>The <app>gedit-code-assistance</app> plugin provides real-time error
22
highlighting for C, C++ and Objective-C. To enable this plugin, select
23
<guiseq><gui style="menu">gedit</gui><gui style="menuitem">Preferences</gui>
24
<gui>Plugins</gui><gui>Code Assistance</gui></guiseq>.</p>
27
<section id="code-assistance-features">
28
<title>Code assistance features</title>
30
<item><p>Feature #1</p></item>
31
<item><p>Feature #2</p></item>
32
<item><p>Feature #3</p></item>
33
<item><p>Feature #4</p></item>
38
<section id="how-gedit-code-assistance-works">
39
<title>How the code assistance plugin works</title>
41
<p>The plugin currently relies on information in the makefile to deduce the
42
Clang error-highlighting rules. It examines the
43
<code its:translate="no">make</code> rules and determines which targets
44
depend on the the file that is being parsed. The plugin then extracts the
45
compiler flags by simulating an execution of those targets.</p>
47
<p>This is not completely fool proof, of course. In the future, the plugin
48
will allow you to manually specify the compile flags.</p>