components/logilab-astng/logilab-astng.3
changeset 114 6cc95ec7b1bb
child 181 87e11e685b1f
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/components/logilab-astng/logilab-astng.3	Tue Mar 01 11:29:05 2011 -0800
@@ -0,0 +1,74 @@
+'\" te
+.\"
+.\" Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
+.\"
+.\" logilab-astng.3
+.\"
+.TH logilab-astng 3 "30 Apr 2009"
+.SH NAME
+logilab-astng \- Python Abstract Syntax Tree New Generation
+.SH DESCRIPTION
+The
+.I logilab-astng
+The aim of this module is to provide a common base representation of 
+python source code for projects such as pychecker, pyreverse, pylint.
+
+.LP
+It is governed by pylint's needs.  It extends class defined in the 
+compiler.ast [1] module with some additional methods and attributes. 
+Instance attributes are added by a builder object, which can either 
+generate extended ast by visiting an existant ast tree or by inspecting 
+living object. Methods are added by monkey patching ast classes.
+
+.LP
+Main modules are:
+.LP
+
+* nodes and scoped_nodes for more information about methods 
+and attributes added to different node classes
+
+.LP
+* the manager contains a high level object to get astng trees 
+from source files and living objects. It maintains a cache of 
+previously constructed tree for quick access
+
+.LP
+* builder contains the class responsible to build astng trees
+
+
+.LP
+
+.SH FILES
+.TP 2.2i
+.B /usr/lib/python2.6/vendor-packages/logilab/astng
+shared object library files
+
+.SH AUTHORS
+Sylvain Thenault ([email protected])
+
+.SH SUPPORT
[email protected]
+
+.SH ATTRIBUTES
+See
+.BR attributes (5)
+for descriptions of the following attributes:
+.sp
+.TS
+box;
+cbp-1 | cbp-1
+l | l .
+ATTRIBUTE TYPE	ATTRIBUTE VALUE
+=
+Availability	library/python-2/logilab-astng
+=
+Interface Stability	Uncommitted
+.TE
+.SH SEE ALSO
+.IR logilab-common (3),
+.IR pylint (1),
+.SH NOTES
+
+Documentation for logilab-astng is available on-line at http://www.logilab.org/project/logilab-astng
+
+Source for logilab-astng is available on http://opensolaris.org.