Revision: 1780 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1780&view=re... Author: colombanw Date: 2010-12-21 18:18:10 +0000 (Tue, 21 Dec 2010)
Log Message: ----------- Drop old non-geany-plugins GeanyGenDoc tree
Development goes in geany-plugins/geanygendoc for some time now, making this copy useless, redundant and confusing.
If you used to use this copy, please switch to geany-plugins/geanygendoc.
Removed Paths: ------------- trunk/geanygendoc/AUTHORS trunk/geanygendoc/COPYING trunk/geanygendoc/INSTALL trunk/geanygendoc/Makefile.am trunk/geanygendoc/README.in trunk/geanygendoc/TODO trunk/geanygendoc/autogen.sh trunk/geanygendoc/configure.ac trunk/geanygendoc/data/Makefile.am trunk/geanygendoc/data/filetypes/Makefile.am trunk/geanygendoc/data/filetypes/c.conf trunk/geanygendoc/data/filetypes/vala.conf trunk/geanygendoc/docs/Makefile.am trunk/geanygendoc/docs/help/Makefile.am trunk/geanygendoc/docs/help/html4css1.css trunk/geanygendoc/docs/help/manual.css trunk/geanygendoc/docs/help/manual.rst trunk/geanygendoc/po/LINGUAS trunk/geanygendoc/po/POTFILES.in trunk/geanygendoc/po/fr.po trunk/geanygendoc/src/Makefile.am trunk/geanygendoc/src/ggd-doc-setting.c trunk/geanygendoc/src/ggd-doc-setting.h trunk/geanygendoc/src/ggd-doc-type.c trunk/geanygendoc/src/ggd-doc-type.h trunk/geanygendoc/src/ggd-file-type-loader.c trunk/geanygendoc/src/ggd-file-type-loader.h trunk/geanygendoc/src/ggd-file-type-manager.c trunk/geanygendoc/src/ggd-file-type-manager.h trunk/geanygendoc/src/ggd-file-type.c trunk/geanygendoc/src/ggd-file-type.h trunk/geanygendoc/src/ggd-macros.h trunk/geanygendoc/src/ggd-options.c trunk/geanygendoc/src/ggd-options.h trunk/geanygendoc/src/ggd-plugin.c trunk/geanygendoc/src/ggd-plugin.h trunk/geanygendoc/src/ggd-tag-utils.c trunk/geanygendoc/src/ggd-tag-utils.h trunk/geanygendoc/src/ggd-utils.c trunk/geanygendoc/src/ggd-utils.h trunk/geanygendoc/src/ggd-widget-doctype-selector.c trunk/geanygendoc/src/ggd-widget-doctype-selector.h trunk/geanygendoc/src/ggd-widget-frame.c trunk/geanygendoc/src/ggd-widget-frame.h trunk/geanygendoc/src/ggd.c trunk/geanygendoc/src/ggd.h
Deleted: trunk/geanygendoc/AUTHORS =================================================================== --- trunk/geanygendoc/AUTHORS 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/AUTHORS 2010-12-21 18:18:10 UTC (rev 1780) @@ -1 +0,0 @@ -Colomban Wendling ban@herbesfolles.org
Deleted: trunk/geanygendoc/COPYING =================================================================== --- trunk/geanygendoc/COPYING 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/COPYING 2010-12-21 18:18:10 UTC (rev 1780) @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. http://fsf.org/ - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - <one line to give the program's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see http://www.gnu.org/licenses/. - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - <program> Copyright (C) <year> <name of author> - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -http://www.gnu.org/licenses/. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -http://www.gnu.org/philosophy/why-not-lgpl.html.
Deleted: trunk/geanygendoc/INSTALL =================================================================== --- trunk/geanygendoc/INSTALL 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/INSTALL 2010-12-21 18:18:10 UTC (rev 1780) @@ -1,365 +0,0 @@ -Installation Instructions -************************* - -Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, -2006, 2007, 2008, 2009 Free Software Foundation, Inc. - - Copying and distribution of this file, with or without modification, -are permitted in any medium without royalty provided the copyright -notice and this notice are preserved. This file is offered as-is, -without warranty of any kind. - -Basic Installation -================== - - Briefly, the shell commands `./configure; make; make install' should -configure, build, and install this package. The following -more-detailed instructions are generic; see the `README' file for -instructions specific to this package. Some packages provide this -`INSTALL' file but do not implement all of the features documented -below. The lack of an optional feature in a given package is not -necessarily a bug. More recommendations for GNU packages can be found -in *note Makefile Conventions: (standards)Makefile Conventions. - - The `configure' shell script attempts to guess correct values for -various system-dependent variables used during compilation. It uses -those values to create a `Makefile' in each directory of the package. -It may also create one or more `.h' files containing system-dependent -definitions. Finally, it creates a shell script `config.status' that -you can run in the future to recreate the current configuration, and a -file `config.log' containing compiler output (useful mainly for -debugging `configure'). - - It can also use an optional file (typically called `config.cache' -and enabled with `--cache-file=config.cache' or simply `-C') that saves -the results of its tests to speed up reconfiguring. Caching is -disabled by default to prevent problems with accidental use of stale -cache files. - - If you need to do unusual things to compile the package, please try -to figure out how `configure' could check whether to do them, and mail -diffs or instructions to the address given in the `README' so they can -be considered for the next release. If you are using the cache, and at -some point `config.cache' contains results you don't want to keep, you -may remove or edit it. - - The file `configure.ac' (or `configure.in') is used to create -`configure' by a program called `autoconf'. You need `configure.ac' if -you want to change it or regenerate `configure' using a newer version -of `autoconf'. - - The simplest way to compile this package is: - - 1. `cd' to the directory containing the package's source code and type - `./configure' to configure the package for your system. - - Running `configure' might take a while. While running, it prints - some messages telling which features it is checking for. - - 2. Type `make' to compile the package. - - 3. Optionally, type `make check' to run any self-tests that come with - the package, generally using the just-built uninstalled binaries. - - 4. Type `make install' to install the programs and any data files and - documentation. When installing into a prefix owned by root, it is - recommended that the package be configured and built as a regular - user, and only the `make install' phase executed with root - privileges. - - 5. Optionally, type `make installcheck' to repeat any self-tests, but - this time using the binaries in their final installed location. - This target does not install anything. Running this target as a - regular user, particularly if the prior `make install' required - root privileges, verifies that the installation completed - correctly. - - 6. You can remove the program binaries and object files from the - source code directory by typing `make clean'. To also remove the - files that `configure' created (so you can compile the package for - a different kind of computer), type `make distclean'. There is - also a `make maintainer-clean' target, but that is intended mainly - for the package's developers. If you use it, you may have to get - all sorts of other programs in order to regenerate files that came - with the distribution. - - 7. Often, you can also type `make uninstall' to remove the installed - files again. In practice, not all packages have tested that - uninstallation works correctly, even though it is required by the - GNU Coding Standards. - - 8. Some packages, particularly those that use Automake, provide `make - distcheck', which can by used by developers to test that all other - targets like `make install' and `make uninstall' work correctly. - This target is generally not run by end users. - -Compilers and Options -===================== - - Some systems require unusual options for compilation or linking that -the `configure' script does not know about. Run `./configure --help' -for details on some of the pertinent environment variables. - - You can give `configure' initial values for configuration parameters -by setting variables in the command line or in the environment. Here -is an example: - - ./configure CC=c99 CFLAGS=-g LIBS=-lposix - - *Note Defining Variables::, for more details. - -Compiling For Multiple Architectures -==================================== - - You can compile the package for more than one kind of computer at the -same time, by placing the object files for each architecture in their -own directory. To do this, you can use GNU `make'. `cd' to the -directory where you want the object files and executables to go and run -the `configure' script. `configure' automatically checks for the -source code in the directory that `configure' is in and in `..'. This -is known as a "VPATH" build. - - With a non-GNU `make', it is safer to compile the package for one -architecture at a time in the source code directory. After you have -installed the package for one architecture, use `make distclean' before -reconfiguring for another architecture. - - On MacOS X 10.5 and later systems, you can create libraries and -executables that work on multiple system types--known as "fat" or -"universal" binaries--by specifying multiple `-arch' options to the -compiler but only a single `-arch' option to the preprocessor. Like -this: - - ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ - CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ - CPP="gcc -E" CXXCPP="g++ -E" - - This is not guaranteed to produce working output in all cases, you -may have to build one architecture at a time and combine the results -using the `lipo' tool if you have problems. - -Installation Names -================== - - By default, `make install' installs the package's commands under -`/usr/local/bin', include files under `/usr/local/include', etc. You -can specify an installation prefix other than `/usr/local' by giving -`configure' the option `--prefix=PREFIX', where PREFIX must be an -absolute file name. - - You can specify separate installation prefixes for -architecture-specific files and architecture-independent files. If you -pass the option `--exec-prefix=PREFIX' to `configure', the package uses -PREFIX as the prefix for installing programs and libraries. -Documentation and other data files still use the regular prefix. - - In addition, if you use an unusual directory layout you can give -options like `--bindir=DIR' to specify different values for particular -kinds of files. Run `configure --help' for a list of the directories -you can set and what kinds of files go in them. In general, the -default for these options is expressed in terms of `${prefix}', so that -specifying just `--prefix' will affect all of the other directory -specifications that were not explicitly provided. - - The most portable way to affect installation locations is to pass the -correct locations to `configure'; however, many packages provide one or -both of the following shortcuts of passing variable assignments to the -`make install' command line to change installation locations without -having to reconfigure or recompile. - - The first method involves providing an override variable for each -affected directory. For example, `make install -prefix=/alternate/directory' will choose an alternate location for all -directory configuration variables that were expressed in terms of -`${prefix}'. Any directories that were specified during `configure', -but not in terms of `${prefix}', must each be overridden at install -time for the entire installation to be relocated. The approach of -makefile variable overrides for each directory variable is required by -the GNU Coding Standards, and ideally causes no recompilation. -However, some platforms have known limitations with the semantics of -shared libraries that end up requiring recompilation when using this -method, particularly noticeable in packages that use GNU Libtool. - - The second method involves providing the `DESTDIR' variable. For -example, `make install DESTDIR=/alternate/directory' will prepend -`/alternate/directory' before all installation names. The approach of -`DESTDIR' overrides is not required by the GNU Coding Standards, and -does not work on platforms that have drive letters. On the other hand, -it does better at avoiding recompilation issues, and works well even -when some directory options were not specified in terms of `${prefix}' -at `configure' time. - -Optional Features -================= - - If the package supports it, you can cause programs to be installed -with an extra prefix or suffix on their names by giving `configure' the -option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. - - Some packages pay attention to `--enable-FEATURE' options to -`configure', where FEATURE indicates an optional part of the package. -They may also pay attention to `--with-PACKAGE' options, where PACKAGE -is something like `gnu-as' or `x' (for the X Window System). The -`README' should mention any `--enable-' and `--with-' options that the -package recognizes. - - For packages that use the X Window System, `configure' can usually -find the X include and library files automatically, but if it doesn't, -you can use the `configure' options `--x-includes=DIR' and -`--x-libraries=DIR' to specify their locations. - - Some packages offer the ability to configure how verbose the -execution of `make' will be. For these packages, running `./configure ---enable-silent-rules' sets the default to minimal output, which can be -overridden with `make V=1'; while running `./configure ---disable-silent-rules' sets the default to verbose, which can be -overridden with `make V=0'. - -Particular systems -================== - - On HP-UX, the default C compiler is not ANSI C compatible. If GNU -CC is not installed, it is recommended to use the following options in -order to use an ANSI C compiler: - - ./configure CC="cc -Ae -D_XOPEN_SOURCE=500" - -and if that doesn't work, install pre-built binaries of GCC for HP-UX. - - On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot -parse its `<wchar.h>' header file. The option `-nodtk' can be used as -a workaround. If GNU CC is not installed, it is therefore recommended -to try - - ./configure CC="cc" - -and if that doesn't work, try - - ./configure CC="cc -nodtk" - - On Solaris, don't put `/usr/ucb' early in your `PATH'. This -directory contains several dysfunctional programs; working variants of -these programs are available in `/usr/bin'. So, if you need `/usr/ucb' -in your `PATH', put it _after_ `/usr/bin'. - - On Haiku, software installed for all users goes in `/boot/common', -not `/usr/local'. It is recommended to use the following options: - - ./configure --prefix=/boot/common - -Specifying the System Type -========================== - - There may be some features `configure' cannot figure out -automatically, but needs to determine by the type of machine the package -will run on. Usually, assuming the package is built to be run on the -_same_ architectures, `configure' can figure that out, but if it prints -a message saying it cannot guess the machine type, give it the -`--build=TYPE' option. TYPE can either be a short name for the system -type, such as `sun4', or a canonical name which has the form: - - CPU-COMPANY-SYSTEM - -where SYSTEM can have one of these forms: - - OS - KERNEL-OS - - See the file `config.sub' for the possible values of each field. If -`config.sub' isn't included in this package, then this package doesn't -need to know the machine type. - - If you are _building_ compiler tools for cross-compiling, you should -use the option `--target=TYPE' to select the type of system they will -produce code for. - - If you want to _use_ a cross compiler, that generates code for a -platform different from the build platform, you should specify the -"host" platform (i.e., that on which the generated programs will -eventually be run) with `--host=TYPE'. - -Sharing Defaults -================ - - If you want to set default values for `configure' scripts to share, -you can create a site shell script called `config.site' that gives -default values for variables like `CC', `cache_file', and `prefix'. -`configure' looks for `PREFIX/share/config.site' if it exists, then -`PREFIX/etc/config.site' if it exists. Or, you can set the -`CONFIG_SITE' environment variable to the location of the site script. -A warning: not all `configure' scripts look for a site script. - -Defining Variables -================== - - Variables not defined in a site shell script can be set in the -environment passed to `configure'. However, some packages may run -configure again during the build, and the customized values of these -variables may be lost. In order to avoid this problem, you should set -them in the `configure' command line, using `VAR=value'. For example: - - ./configure CC=/usr/local2/bin/gcc - -causes the specified `gcc' to be used as the C compiler (unless it is -overridden in the site shell script). - -Unfortunately, this technique does not work for `CONFIG_SHELL' due to -an Autoconf bug. Until the bug is fixed you can use this workaround: - - CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash - -`configure' Invocation -====================== - - `configure' recognizes the following options to control how it -operates. - -`--help' -`-h' - Print a summary of all of the options to `configure', and exit. - -`--help=short' -`--help=recursive' - Print a summary of the options unique to this package's - `configure', and exit. The `short' variant lists options used - only in the top level, while the `recursive' variant lists options - also present in any nested packages. - -`--version' -`-V' - Print the version of Autoconf used to generate the `configure' - script, and exit. - -`--cache-file=FILE' - Enable the cache: use and save the results of the tests in FILE, - traditionally `config.cache'. FILE defaults to `/dev/null' to - disable caching. - -`--config-cache' -`-C' - Alias for `--cache-file=config.cache'. - -`--quiet' -`--silent' -`-q' - Do not print messages saying which checks are being made. To - suppress all normal output, redirect it to `/dev/null' (any error - messages will still be shown). - -`--srcdir=DIR' - Look for the package's source code in directory DIR. Usually - `configure' can determine that directory automatically. - -`--prefix=DIR' - Use DIR as the installation prefix. *note Installation Names:: - for more details, including other options available for fine-tuning - the installation locations. - -`--no-create' -`-n' - Run the configure checks, but stop before creating any output - files. - -`configure' also accepts some other, not widely useful, options. Run -`configure --help' for more details. -
Deleted: trunk/geanygendoc/Makefile.am =================================================================== --- trunk/geanygendoc/Makefile.am 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/Makefile.am 2010-12-21 18:18:10 UTC (rev 1780) @@ -1,18 +0,0 @@ - -SUBDIRS = src data po docs - -ACLOCAL_AMFLAGS = -I build/m4 - -EXTRA_DIST = autogen.sh \ - README \ - po/LINGUAS - -doc_DATA = AUTHORS \ - COPYING \ - README - -sign: - if test -f $(PACKAGE)-$(VERSION).tar.gz; then \ - gpg --detach-sign --digest-algo SHA512 $(PACKAGE)-$(VERSION).tar.gz; fi - if test -f $(PACKAGE)-$(VERSION).tar.bz2; then \ - gpg --detach-sign --digest-algo SHA512 $(PACKAGE)-$(VERSION).tar.bz2; fi
Deleted: trunk/geanygendoc/README.in =================================================================== --- trunk/geanygendoc/README.in 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/README.in 2010-12-21 18:18:10 UTC (rev 1780) @@ -1,37 +0,0 @@ -General Information -=================== - -This is GeanyGenDoc @VERSION@, a plugin for Geany that aims to automatically -generate documentation comment basis from the source code. - -Requirements -============ - -You will need the following packages to build GeanyGenDoc: - - Geany >= 0.19 (http://www.geany.org/) - - GTK+ >= 2.12 (http://www.gtk.org) - - GLib >= 2.14 (http://www.gtk.org) - - GIO >= 2.18 (http://www.gtk.org) - - CTPL >= 0.2 (http://ctpl.tuxfamily.org/) - - A working C compiler (GCC for example, http://gcc.gnu.org/) - - A working make implementation (GNU make is recommended, - http://www.gnu.org/software/make/) - -You may also want the following packages that enables extra features: - - Docutils (http://docutils.sourceforge.net/) -- or another implementation of - rst2html -- is needed to (re)generate the HTML manual. - - -Installation -============ - -Compiling and installing the plugin is done by the following commands: - - $ ./configure - $ make - $ make install - -For more configuration details run - $ ./configure --help - -For detailed instructions, see the INSTALL file.
Deleted: trunk/geanygendoc/TODO =================================================================== --- trunk/geanygendoc/TODO 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/TODO 2010-12-21 18:18:10 UTC (rev 1780) @@ -1,19 +0,0 @@ -* support setting duplication in filetype configuration - function = { - template = "my template"; - # more settings... - } - prototype = function; - macro = function; - This would be really convenient with function, macro and prototypes for - example. - -* Support doctype-specific user-defined environment chunks. - Problem: there is (for now) nothing here for this kind of settings - (doctype-global but also specific to it). - -* Store doctype in a per-document basis? It would be cool, but not sure it is - possible without re-implementing a lot of document history. - -* Add a pop-up menu to the document type selector for common actions (edit, - clear, etc.).
Deleted: trunk/geanygendoc/autogen.sh =================================================================== --- trunk/geanygendoc/autogen.sh 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/autogen.sh 2010-12-21 18:18:10 UTC (rev 1780) @@ -1,8 +0,0 @@ -#!/bin/sh - - -mkdir -p build/aux || exit 1 -mkdir -p build/m4 || exit 1 -#~ gtkdocize --flavour no-tmpl || exit 1 -glib-gettextize -c -f || exit 1 -autoreconf -vfi || exit 1
Deleted: trunk/geanygendoc/configure.ac =================================================================== --- trunk/geanygendoc/configure.ac 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/configure.ac 2010-12-21 18:18:10 UTC (rev 1780) @@ -1,90 +0,0 @@ -# Process this file with autoconf to produce a configure script. - -AC_PREREQ([2.64]) -AC_INIT([geanygendoc], - [0.1], - [ban@herbesfolles.org], - [geanygendoc]) -AC_CONFIG_SRCDIR([src/ggd.c]) -AC_CONFIG_AUX_DIR([build/aux]) -AC_CONFIG_MACRO_DIR([build/m4]) -AM_INIT_AUTOMAKE([1.11.1 -Wall -Werror foreign]) -AC_CONFIG_HEADERS([config.h]) - -m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])]) - -AC_PROG_CC -LT_PREREQ([2.2.0]) -LT_INIT([disable-static]) -AC_PROG_INSTALL - -AC_PATH_PROG([RST2HTML], [rst2html], [no]) -AC_SUBST([RST2HTML]) -BUILD_RST=`test "x$RST2HTML" != "xno" && echo Yes || echo No` -AM_CONDITIONAL([BUILD_RST], [test "x$BUILD_RST" == "xYes"]) - -# checking for Geany -PKG_CHECK_MODULES(GEANY, [geany >= 0.18.1]) -PKG_CHECK_MODULES(GTK, [gtk+-2.0 >= 2.12]) -PKG_CHECK_MODULES(GLIB, [glib-2.0 >= 2.14]) -# need GIO >= 2.18 for g_memory_output_stream_get_data_size() -PKG_CHECK_MODULES(GIO, [gio-2.0 >= 2.18]) -PKG_CHECK_MODULES(CTPL, [ctpl >= 0.2]) - -GEANY_VERSION=`$PKG_CONFIG --modversion geany` -GTK_VERSION=`$PKG_CONFIG --modversion gtk+-2.0` -GLIB_VERSION=`$PKG_CONFIG --modversion glib-2.0` -GIO_VERSION=`$PKG_CONFIG --modversion gio-2.0` -CTPL_VERSION=`$PKG_CONFIG --modversion ctpl` - -# i18n -GETTEXT_PACKAGE=geanygendoc -AC_SUBST(GETTEXT_PACKAGE) -AC_DEFINE_UNQUOTED(GETTEXT_PACKAGE, "$GETTEXT_PACKAGE", [Gettext package.]) - -ALL_LINGUAS="`sed -e '/^#/d' $srcdir/po/LINGUAS`" # take all languages found in file po/LINGUAS - -AM_GLIB_GNU_GETTEXT -# workaround for intltool bug (http://bugzilla.gnome.org/show_bug.cgi?id=490845) -if test "x$MSGFMT" = "xno"; then - AC_MSG_ERROR([msgfmt not found. Please install the gettext package.]) -fi - -# intltool hack to define install_sh on Debian/Ubuntu systems -if test "x$install_sh" = "x"; then - install_sh="`pwd`/install-sh" - AC_SUBST(install_sh) -fi - -# get the plugin installed at the correct location for Geany -# TODO find a way to NOT override --libdir command line option if given -libdir="`$PKG_CONFIG --variable=libdir geany`/geany" -# same for the data, since we use geany->app->datadir -plugindatadir="`$PKG_CONFIG --variable=datadir geany`/geany/plugins/${PACKAGE_TARNAME}" -AC_SUBST([plugindatadir]) -# docdir -docdir="`$PKG_CONFIG --variable=prefix geany`/share/doc/geany-plugins/${PACKAGE_TARNAME}/" - - -AC_CONFIG_FILES([ - README - Makefile - src/Makefile - data/Makefile - data/filetypes/Makefile - po/Makefile.in - docs/Makefile - docs/help/Makefile -]) -AC_OUTPUT - -echo "----------------------------------------" -echo "Using Geany version : ${GEANY_VERSION}" -echo "Using GLib version : ${GLIB_VERSION}" -echo "Using GIO version : ${GIO_VERSION}" -echo "Using GTK version : ${GTK_VERSION}" -echo "Using CTPL version : ${CTPL_VERSION}" -echo "Build documentation : $BUILD_RST" -echo "" -echo "Configuration is done OK." -echo ""
Deleted: trunk/geanygendoc/data/Makefile.am =================================================================== --- trunk/geanygendoc/data/Makefile.am 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/data/Makefile.am 2010-12-21 18:18:10 UTC (rev 1780) @@ -1 +0,0 @@ -SUBDIRS = filetypes
Deleted: trunk/geanygendoc/data/filetypes/Makefile.am =================================================================== --- trunk/geanygendoc/data/filetypes/Makefile.am 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/data/filetypes/Makefile.am 2010-12-21 18:18:10 UTC (rev 1780) @@ -1,5 +0,0 @@ -filetypesdir = $(plugindatadir)/filetypes -filetypes_DATA = c.conf \ - vala.conf - -EXTRA_DIST = $(filetypes_DATA)
Deleted: trunk/geanygendoc/data/filetypes/c.conf =================================================================== --- trunk/geanygendoc/data/filetypes/c.conf 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/data/filetypes/c.conf 2010-12-21 18:18:10 UTC (rev 1780) @@ -1,106 +0,0 @@ - -settings = { - # [[modifier ]type ]arg[square brackets, white spaces, ...](,|EOL) with support - # of prototype as argument types (not recursive). - # - # Detailed expression: - #function_args=(?: - # matches () and (void) not to try to extract an argument for them - # ^([ \t]*(?:void)?[ \t]*)$ - # | - # type or modifier (e.g. "char *") - # (?:[a-zA-Z0-9_]+[ \t*]+ - # prototype start (e.g. "(*", start of (*arg)) - # (?:([ \t*]*)?)* - # the argument name itself (only capture) - # ([a-zA-Z0-9_.]+) - # prototype end (e.g. ")", end of (*arg)) - # (?:[ \t]*))? - # possible white-spaces - # [ \t]* - # prototype arguments: we match anything between parentheses - # (?:([^)]*))? - # permissive match for post-arg (e.g. array size) - # [^,]* - # , or EOL - # (?:,|$) - # ) - # note that \ are escaped, so to have a \ you need to put \ - match_function_arguments = "(?:^\([ \t]*(?:void)?[ \t]*\)$|(?:[a-zA-Z0-9_]+[ \t*]+(?:\([ \t*]*)?)*([a-zA-Z0-9_.]+)(?:[ \t]*\))?[ \t]*(?:\([^)]*\))?[^,]*(?:,|$))"; - - # global env - global_environment = "doxygen_prefix = "@"; - write_since = 0;"; -} - -doctypes = { - gtkdoc = { - # Forward should be before the others to match first - struct.struct.policy = FORWARD; - struct.union.policy = FORWARD; - struct.prototype.policy = FORWARD; - member.policy = FORWARD; - enumval.policy = FORWARD; - - function = { - template = "/**\n * {symbol}:\n{for arg in argument_list} * @{arg}: {cursor}\n{end} * \n * {cursor}\n{if returns} * \n * Returns: \n{end}{if write_since}{if returns} * \n{end} * Since: \n{end} */\n"; - position = BEFORE; - policy = KEEP; - } - macro = { - template = "/**\n * {symbol}:\n{for arg in argument_list} * @{arg}: {cursor}\n{end} * \n * {cursor}\n{if returns} * \n * Returns: \n{end} */\n"; - } - struct = { - template = "/**\n * {symbol}:\n{for member in children} * @{member}: {cursor}\n{end} * \n * {cursor}\n */\n"; - position = BEFORE; - policy = KEEP; - children = MERGE; - matches = member | prototype; - } - enum = { - template = "/**\n * {symbol}:\n{for enumval in enumval_list} * @{enumval}: {cursor}\n{end} * \n * {cursor}\n */\n"; - } - union = { - template = "/**\n * {symbol}:\n{for member in children} * @{member}: {cursor}\n{end} * \n * {cursor}\n */\n"; - children = MERGE; - } - typedef = { - template = "/**\n * {symbol}:\n * \n * {cursor}\n */\n"; - } - define = { - template = "/**\n * {symbol}:\n * \n * {cursor}\n */\n"; - } - } - - doxygen = { - function.template = "/**\n * {doxygen_prefix}brief: {cursor}\n{for a in argument_list} * {doxygen_prefix}param {a} \n{end}{if returns} * {doxygen_prefix}returns \n{end}{if write_since} * {doxygen_prefix}since \n{end} * \n * \n */\n"; - macro.template = "/**\n * {doxygen_prefix}brief: {cursor}\n{for a in argument_list} * {doxygen_prefix}param {a} \n{end}{if returns} * {doxygen_prefix}returns \n{end}{if write_since} * {doxygen_prefix}since \n{end} * \n * \n */\n"; - struct.member = { - template = " /**< {cursor} */"; - position = AFTER; - } - struct = { - template = "/**\n * {doxygen_prefix}brief: {cursor}\n * \n * \n */\n"; - auto_doc_children = True; - } - union.member = { - template = " /**< {cursor} */"; - position = AFTER; - } - union = { - template = "/**\n * {doxygen_prefix}brief: {cursor}\n * \n * \n */\n"; - auto_doc_children = True; - } - enum = { - template = "/**\n * {doxygen_prefix}brief: {cursor}\n * \n * \n */\n"; - auto_doc_children = True; - } - enum.enumval = { - template = " /**< {cursor} */"; - position = AFTER; - } - typedef.template = "/**\n * {doxygen_prefix}brief: {cursor}\n * \n * \n */\n"; - define.template = "/**\n * {doxygen_prefix}brief: {cursor}\n * \n * \n */\n"; - } -} -
Deleted: trunk/geanygendoc/data/filetypes/vala.conf =================================================================== --- trunk/geanygendoc/data/filetypes/vala.conf 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/data/filetypes/vala.conf 2010-12-21 18:18:10 UTC (rev 1780) @@ -1,40 +0,0 @@ - -settings = { - # [[direction ]type ]arg[...](,|EOL) - # - # Detailed expression: - #function_args=(?: - # matches () not to try to extract an argument for it - # ^([ \t]*)$ - # | - # type or modifier (e.g. "char *", "string?[42]" or "List<string>") - # (?:[a-zA-Z0-9_]+[ \t*?]*(?:(?:\[|<)[a-zA-Z0-9_[]*?]*(?:\]|>))?[ \t*?]+)* - # the argument name itself (only capture) - # ([a-zA-Z0-9_.]+) - # prototype end (e.g. ")", end of (*arg)) - # (?:[ \t]*))? - # possible white-spaces - # [ \t]* - # permissive match for post-arg (any shit we didn't thought about) - # [^,]* - # , or EOL - # (?:,|$) - # ) - # note that \ are escaped, so to have a \ you need to put \ - match_function_arguments = "(?:^\([ \t]*\)$|(?:[a-zA-Z0-9_]+[ \t*?]*(?:(?:\[|<)[a-zA-Z0-9_\[\]*?]*(?:\]|>))?[ \t*?]+)*([a-zA-Z0-9_.]+)[ \t]*[^,]*(?:,|$))"; - - # global env - global_environment = "write_since = 0;"; -} - -doctypes = { - valadoc = { - enumval.policy = FORWARD; - - class.template = "/**\n * {cursor}\n{if write_since} * \n * @since \n{end} */\n"; - field.template = "/**\n * {cursor}\n{if write_since} * \n * @since \n{end} */\n"; - method.template = "/**\n * {cursor}\n * \n{for arg in argument_list} * @param {arg} {cursor}\n{end}{if returns} * @return {cursor}\n{end}{if write_since} * \n * @since {cursor}\n{end} */\n"; - enum.template = "/**\n * {cursor}\n * \n{for enumval in enumval_list} * @param {enumval} {cursor}\n{end}{if write_since} * \n * @since {cursor}\n{end} */\n"; - } -} -
Deleted: trunk/geanygendoc/docs/Makefile.am =================================================================== --- trunk/geanygendoc/docs/Makefile.am 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/docs/Makefile.am 2010-12-21 18:18:10 UTC (rev 1780) @@ -1 +0,0 @@ -SUBDIRS = help
Deleted: trunk/geanygendoc/docs/help/Makefile.am =================================================================== --- trunk/geanygendoc/docs/help/Makefile.am 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/docs/help/Makefile.am 2010-12-21 18:18:10 UTC (rev 1780) @@ -1,14 +0,0 @@ -EXTRA_DIST = manual.rst \ - manual.css \ - html4css1.css - -doc_DATA = - -if BUILD_RST -doc_DATA += manual.html - -EXTRA_DIST += manual.html - -manual.html: manual.rst manual.css - $(AM_V_GEN) $(RST2HTML) -d --strict --stylesheet-path manual.css $< $@ -endif BUILD_RST
Deleted: trunk/geanygendoc/docs/help/html4css1.css =================================================================== --- trunk/geanygendoc/docs/help/html4css1.css 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/docs/help/html4css1.css 2010-12-21 18:18:10 UTC (rev 1780) @@ -1,293 +0,0 @@ -/* -:Author: David Goodger (goodger@python.org) -:Id: $Id: html4css1.css 5951 2009-05-18 18:03:10Z milde $ -:Copyright: This stylesheet has been placed in the public domain. - -Default cascading style sheet for the HTML output of Docutils. - -See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to -customize this style sheet. -*/ - -/* used to remove borders from tables and images */ -.borderless, table.borderless td, table.borderless th { - border: 0 } - -table.borderless td, table.borderless th { - /* Override padding for "table.docutils td" with "! important". - The right padding separates the table cells. */ - padding: 0 0.5em 0 0 ! important } - -.first { - /* Override more specific margin styles with "! important". */ - margin-top: 0 ! important } - -.last, .with-subtitle { - margin-bottom: 0 ! important } - -.hidden { - display: none } - -a.toc-backref { - text-decoration: none ; - color: black } - -blockquote.epigraph { - margin: 2em 5em ; } - -dl.docutils dd { - margin-bottom: 0.5em } - -/* Uncomment (and remove this text!) to get bold-faced definition list terms -dl.docutils dt { - font-weight: bold } -*/ - -div.abstract { - margin: 2em 5em } - -div.abstract p.topic-title { - font-weight: bold ; - text-align: center } - -div.admonition, div.attention, div.caution, div.danger, div.error, -div.hint, div.important, div.note, div.tip, div.warning { - margin: 2em ; - border: medium outset ; - padding: 1em } - -div.admonition p.admonition-title, div.hint p.admonition-title, -div.important p.admonition-title, div.note p.admonition-title, -div.tip p.admonition-title { - font-weight: bold ; - font-family: sans-serif } - -div.attention p.admonition-title, div.caution p.admonition-title, -div.danger p.admonition-title, div.error p.admonition-title, -div.warning p.admonition-title { - color: red ; - font-weight: bold ; - font-family: sans-serif } - -/* Uncomment (and remove this text!) to get reduced vertical space in - compound paragraphs. -div.compound .compound-first, div.compound .compound-middle { - margin-bottom: 0.5em } - -div.compound .compound-last, div.compound .compound-middle { - margin-top: 0.5em } -*/ - -div.dedication { - margin: 2em 5em ; - text-align: center ; - font-style: italic } - -div.dedication p.topic-title { - font-weight: bold ; - font-style: normal } - -div.figure { - margin-left: 2em ; - margin-right: 2em } - -div.footer, div.header { - clear: both; - font-size: smaller } - -div.line-block { - display: block ; - margin-top: 1em ; - margin-bottom: 1em } - -div.line-block div.line-block { - margin-top: 0 ; - margin-bottom: 0 ; - margin-left: 1.5em } - -div.sidebar { - margin: 0 0 0.5em 1em ; - border: medium outset ; - padding: 1em ; - background-color: #ffffee ; - width: 40% ; - float: right ; - clear: right } - -div.sidebar p.rubric { - font-family: sans-serif ; - font-size: medium } - -div.system-messages { - margin: 5em } - -div.system-messages h1 { - color: red } - -div.system-message { - border: medium outset ; - padding: 1em } - -div.system-message p.system-message-title { - color: red ; - font-weight: bold } - -div.topic { - margin: 2em } - -h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, -h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { - margin-top: 0.4em } - -h1.title { - text-align: center } - -h2.subtitle { - text-align: center } - -hr.docutils { - width: 75% } - -img.align-left, .figure.align-left{ - clear: left ; - float: left ; - margin-right: 1em } - -img.align-right, .figure.align-right { - clear: right ; - float: right ; - margin-left: 1em } - -.align-left { - text-align: left } - -.align-center { - clear: both ; - text-align: center } - -.align-right { - text-align: right } - -/* reset inner alignment in figures */ -div.align-right { - text-align: left } - -/* div.align-center * { */ -/* text-align: left } */ - -ol.simple, ul.simple { - margin-bottom: 1em } - -ol.arabic { - list-style: decimal } - -ol.loweralpha { - list-style: lower-alpha } - -ol.upperalpha { - list-style: upper-alpha } - -ol.lowerroman { - list-style: lower-roman } - -ol.upperroman { - list-style: upper-roman } - -p.attribution { - text-align: right ; - margin-left: 50% } - -p.caption { - font-style: italic } - -p.credits { - font-style: italic ; - font-size: smaller } - -p.label { - white-space: nowrap } - -p.rubric { - font-weight: bold ; - font-size: larger ; - color: maroon ; - text-align: center } - -p.sidebar-title { - font-family: sans-serif ; - font-weight: bold ; - font-size: larger } - -p.sidebar-subtitle { - font-family: sans-serif ; - font-weight: bold } - -p.topic-title { - font-weight: bold } - -pre.address { - margin-bottom: 0 ; - margin-top: 0 ; - font: inherit } - -pre.literal-block, pre.doctest-block { - margin-left: 2em ; - margin-right: 2em } - -span.classifier { - font-family: sans-serif ; - font-style: oblique } - -span.classifier-delimiter { - font-family: sans-serif ; - font-weight: bold } - -span.interpreted { - font-family: sans-serif } - -span.option { - white-space: nowrap } - -span.pre { - white-space: pre } - -span.problematic { - color: red } - -span.section-subtitle { - /* font-size relative to parent (h1..h6 element) */ - font-size: 80% } - -table.citation { - border-left: solid 1px gray; - margin-left: 1px } - -table.docinfo { - margin: 2em 4em } - -table.docutils { - margin-top: 0.5em ; - margin-bottom: 0.5em } - -table.footnote { - border-left: solid 1px black; - margin-left: 1px } - -table.docutils td, table.docutils th, -table.docinfo td, table.docinfo th { - padding-left: 0.5em ; - padding-right: 0.5em ; - vertical-align: top } - -table.docutils th.field-name, table.docinfo th.docinfo-name { - font-weight: bold ; - text-align: left ; - white-space: nowrap ; - padding-left: 0 } - -h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, -h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { - font-size: 100% } - -ul.auto-toc { - list-style-type: none }
Deleted: trunk/geanygendoc/docs/help/manual.css =================================================================== --- trunk/geanygendoc/docs/help/manual.css 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/docs/help/manual.css 2010-12-21 18:18:10 UTC (rev 1780) @@ -1,68 +0,0 @@ -/* -:Author: Colomban Wendling -:Contact: ban@herbesfolles.org -:Copyright: This stylesheet has been placed in the public domain. - -Stylesheet for use with Docutils. -*/ - -@import url(html4css1.css); - -html { - background-color: #eeeeec; - color: #2e3436; - font-family: bitstream vera sans, sans-serif; - margin: 0 1em; -} - - -h1, h2, h3, h4, h5, h6, p.topic-title { - font-family: georgia, times new roman, times, serif; -} - -h2.subtitle { - font-style: italic; - font-weight: normal; -} - -p, dd { - text-align: justify; -} - -.literal-block, -.literal { - background: #fff; -} -.literal-block { - border: 1px solid #babdb6; - padding: 1px 2px; -} -h1 .literal, h2 .literal, h3 .literal, h4 .literal, h5 .literal, h6 .literal -p.topic-title .literal { - background: inherit; - text-align: left; -} - - -.footnote-reference { - vertical-align: super; - font-size: 75%; -} - - -a { text-decoration: none; } -a:hover { text-decoration: underline } -a:link { color: #204a87; } -a:visited { color: #5c3566; } - -h1 a, h1 a:hover, h1 a:link, h1 a:visited, -h2 a, h2 a:hover, h2 a:link, h2 a:visited, -h3 a, h3 a:hover, h3 a:link, h3 a:visited, -h4 a, h4 a:hover, h4 a:link, h4 a:visited, -h5 a, h5 a:hover, h5 a:link, h5 a:visited, -h6 a, h6 a:hover, h6 a:link, h6 a:visited, -p.topic-title a, p.topic-title a:hover, p.topic-title a:link, p.topic-title a:visited -{ - text-decoration: none; - color: inherit; -}
Deleted: trunk/geanygendoc/docs/help/manual.rst =================================================================== --- trunk/geanygendoc/docs/help/manual.rst 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/docs/help/manual.rst 2010-12-21 18:18:10 UTC (rev 1780) @@ -1,535 +0,0 @@ -======================= -GeanyGenDoc User Manual -======================= -------------------------------------------------- -A handy hand guide for the lazy documenter in you -------------------------------------------------- - - -Introduction -============ - -First of all, welcome to this manual. Then, what is GeanyGenDoc? It is a -plug-in for Geany as you might have noticed; but what is it meant to do? -Basically, it generates and inserts text chunks, particularly from document's -symbols. Its goal is to ease writing documentation for the good. - - -.. contents:: - - -Design -====== - -GeanyGenDoc has an extensible design based on three points: file type, -documentation type and rules. - -`File type`_ - The file type determines which configuration applies to which document. For - example, the "c" file type corresponds to C source, and so on. - -`Documentation type`_ - A documentation type is an arbitrary name for a set of rules. The goal of - documentation types is to allow different set of rules to be defined for each - file type. - One might want to have separate rules to generate for example `Doxygen`_ - and `Gtk-Doc`_ documentation from C sources. She should then create two - documentation types in the C `file type configuration file`_, such as - "doxygen" and "gtkdoc". - -`Rule`_ - A rule is a group of settings controlling how a documentation comment is - generated. For example, it can define a template, describe how to handle - particular imbrications and so on. - - -Syntax -====== - -Key-Value pairs ---------------- - -The syntax used by the configuration files is an extended key-value tree -definition based on common concepts (trees, string literals, semicolon-ended -values, etc.). - -The key-value syntax is as follows:: - - key = value - -where value is either a semicolon-ended single value:: - - value; - -or a brace-surrounded list of key-value pairs that use the same syntax again:: - - { - key1 = value1 - key2 = value2 - } - -Here a little example of the *syntax* (not any actual configuration example):: - - key1 = value1; - key2 = { - sub-key1 = sub-value1; - sub-key2 = { - sub-sub-key1 = sub-sub-value1; - } - } - - -Naming ------- - -Key-value pairs are often referred as *group* when they are meant to have -multiple values and as *setting* when they have a single value. - - -Comments --------- - -Is considered as comment (and therefore ignored) everything between a number -sign (``#``) and the following end of line, unless the ``#`` occurs as part of -another syntactic element (such as a string literal). - -A short example:: - - # This is a comment - key = value; # This is also a comment - string = "A string. # This isn't a comment but a string"; - - -Value types ------------ - -string - A string literal. String literals are surrounded by either single (``'``) or - double (``"``) quotes. - - Some special characters can be inserted in a string with an escape sequence: - - ``\t`` - A tabulation. - ``\n`` - A new line. - ``\r`` - A carriage return. - ``\`` - A backslash. - ``'`` - A single quote (escaping only needed in single-quotes surrounded strings). - ``"`` - A double quote (escaping only needed in double-quotes surrounded strings). - - Note that backslashes are used as the escaping character, which means that it - must be escaped to be treated as a simple backslash character. - - A simple example:: - - "This is a string with "special" characters.\nThis is another line!" - -boolean - A boolean. It can take one of the two symbolic values ``True`` and ``False``. - -enumeration - An enumeration. It consists of a named constant, generally in capital letters. - The possible values depend on the setting that use this type. - -flags - A logical OR of named constants. This is like enumerations but can combine - different values. - - The syntax is common for such types and uses the pipe (``|``) as - combination character. Considering the ``A``, ``B`` and ``C`` constants, a - valid value could be ``A | C``, which represents both ``A`` and ``C`` but - not ``B``. - -list - A list of values (often referred as array). - - -File types -========== - -The file type determines which configuration applies to which document. -*File type identifiers* are the lowercased name of the Geany's file type, for -example "c" or "python". - -Configuration for a particular file type goes in a file named -``file-type-identifier.conf`` in the ``filetypes`` sub-directory of a -`configuration directory`_. - -A file type configuration can contain two type of things: file-type-wide -settings and any number of `documentation types`_. - - -The ``settings`` group ----------------------- - -This group contains the file-type-wide settings. - -``match_function_arguments`` (string) - A regular expression used to extract arguments from a function-style argument - list (functions, methods, macros, etc.). This regular expression should match - one argument at a time and capture only the argument's name. - This setting is a little odd but currently needed to extract argument list - from function definitions. - -``global_environment`` (string) - A description of a CTPL_ environment to add when parsing rule_'s templates. - - -The ``doctypes`` group ----------------------- - -This group contains a list of `documentation types`_. - - -Documentation types -=================== - -A documentation type is a named set of rules_ for a `file type`_, describing how -to generate a particular type of documentation (i.e. Doxygen_, `Gtk-Doc`_, -Valadoc_ or whatever). - -A documentation type is identified by its name and must therefore be unique -in a file type. But of course, different file types can define the same -documentation type. It is even recommended for a better consistency to use the -same identifier in different file types when they generate the same type of -documentation (even though it is completely up to you). - - -Short example -------------- - -:: - - doxygen = { - struct.member = { - template = " /**< {cursor} */"; - position = AFTER; - } - struct.template = "/**\n * @brief: {cursor}\n * \n * \n */\n"; - } - - -Rules: the cool thing -===================== - -Rules are the actual definition of how documentation is generated. A rule -applies to a symbol type and hierarchy, allowing fine control over which and -how symbols are documented. - -A rule is represented as a group of `settings`_ in a `documentation type`_. -The name of this group is the `type hierarchy`_ to which the settings applies. - - -Type hierarchy --------------- - -A type hierarchy is a hierarchy of the types that a symbol must have to match -this rule. - -In the symbol side, the type hierarchy is the types of the symbol's parents, -terminated by the symbol's own type. For example, a method in a class would -have a hierarchy like ``class -> method``; and if the class is itself in a -namespace, the hierarchy would the look like ``namespace -> class -> method``, -and so on. - -For a rule to apply, its type hierarchy must match *the end* of the symbol -type hierarchy. For example a rule with the type hierarchy ``class`` will match -a symbol with the type hierarchy ``namespace -> class`` but not one with -``class -> method``. - -A type hierarchy uses dots (``.``) to separate types and build the hierarchy. -For example, the type hierarchy representing ``namespace -> class`` would be -written ``namespace.class``. - - -Known types -~~~~~~~~~~~ - -``class`` - A class. -``enum`` - An enumeration. -``enumval`` - An enumeration value. -``field`` - A field (of a class for example). -``function`` - A function. -``interface`` - An interface. -``member`` - A member (of a structure for example). -``method`` - A method. -``namespace`` - A namespace. -``package`` - A package. -``prototype`` - A prototype. -``struct`` - A structure. -``typedef`` - A type alias definition (*typedef* in C). -``union`` - An union. -``variable`` - A variable. -``extern`` - `???` -``define`` - A definition (like the *define* C preprocessor macro). -``macro`` - A macro. -``file`` - A file (will never match). - - -Rule settings -------------- - -``template`` (string) - A CTPL_ template that can include references to the following predefined - variables in addition to the file-type-wide and the global environment: - - ``argument_list`` (string list) - A list of the arguments of the currently documented symbol. - - ``returns`` (boolean) - Indicates whether the currently documented symbol returns a value - (makes sense only for symbols that may return a value). - - ``children`` (string list) - A list of the current symbol's first-level children. This is only set if - the rule's setting ``children`` is set to ``MERGE``. - - **[...]** - - ``cursor`` (special, described below) - This can be used to mark in the template the position where the editor's - cursor should be moved to after comment insertion. - This mark will be removed from the generated documentation. - Note that even if this mark may occur as many times as you want in a - template, only the first will be actually honored, the latter being - only removed. - -``position`` (enumeration) - The position where the documentation should be inserted. Possible values are: - - ``BEFORE`` [default]_ - Inserts the documentation just before the symbol. - - ``AFTER`` - Inserts the documentation just after the symbol (currently quite limited, it - inserts the documentation at the end of the symbol's first line). - - ``CURSOR`` - Inserts the documentation at the current cursor position. - -``policy`` (enumeration) - How the symbol is documented. Possible values are: - - ``KEEP`` [default]_ - The symbol documents itself. - - ``FORWARD`` - Forward the documentation request to the parent. This is useful for symbols - that are documented by their parent, such as `Gtk-Doc`_'s enumerations. - -``children`` (enumeration) - How the symbol's children can be used in the template. Possible values are: - - ``SPLIT`` [default]_ - The symbol's children are provided as per-type lists. - - ``MERGE`` - The symbol's children are provided as a single list named ``children``. - -``matches`` (flags) - List of the children types that should be provided. Only useful if the - ``children`` setting is set to ``MERGE``. - Defaults to all. - **FIXME: check the exactitude of this description** - -``auto_doc_children`` (boolean) - Whether to also document symbol's children (according to their own rules). - - -User interface in Geany -======================= - -Menus ------ - -GeanyGenDoc adds an item named `Insert Documentation Comment` in the editor's -pop-up under the `Insert Comments` sub-menu; and a menu named -`Documentation Generator` into the `Tools` menu. - -Editor's pop-up menu -~~~~~~~~~~~~~~~~~~~~ - -The item `Editor's pop-up → Insert Comments → Insert Documentation Comment` -generates documentation for the current symbol. It has a keyboard shortcut -that can be configured through Geany's keybinding configuration system, under -`GeanyGenDoc → Insert Documentation Comment`. - -Tools menu -~~~~~~~~~~ - -The `Documentation Generator` menu under `Tools` contains the following items: - -`Document Current Symbol` - This generates documentation for the current symbol. It is equivalent to the - item `Insert Documentation Comment` that can be found in the editor's pop-up - menu. - -`Document All Symbols` - This generates documentation for all symbols in the document. This is - equivalent to manually requesting documentation generation for each symbol in - the document. - -`Reload Configuration Files` - This force reloading of all the `file type`_ configuration files. It is - useful when a file type configuration file was modified, in order to the new - configuration to be used without reloading the plugin. - -`Edit Current Language Configuration` - This opens the configuration file that applies to the current document for - editing. The opened configuration file has write permissions: if it was a - system configuration file it is copied under your personal `configuration - directory`_ transparently. - -`Open Manual` - Opens this manual in a browser. - - -Preferences dialog ------------------- - -The preferences dialog, than can either be opened through `Edit → -Plugin Preferences` or with the `Preferences` button in the plugin manager, -allows to modify the following preferences: - -`General` - `Save file before generating documentation` - Choose whether the current document should be saved to disc before - generating the documentation. This is a technical detail, but it is - currently needed to have an up-to-date tag list. If you disable this option - and ask for documentation generation on a modified document, the behavior - may be surprising since the comment will be generated for the last saved - state of the document and not the current one. - - `Indent inserted documentation` - Chooses whether the inserted documentation should be indented to fit the - indentation at the insertion position. - -`Documentation type` - This list allows you to choose the documentation type to use with each file - type. The special language `All` on top of the list is used to choose the - default documentation type, used for all languages that haven't one set. - -`Global environment` - Global environment overrides and additions. This is an environment that will - be merged with the `file type`_-specific ones, possibly overriding some parts. - It can be used to define some values for all the file types, such as whether - to write the common `Since` tag, define the `Doxygen`_ prefix an so on. - Its most use case is not to need to change a file type's environment to change - the value of one of its elements. - - -Miscellaneous -============= - -Configuration directories -------------------------- - -Configuration directories hold GeanyGenDoc's configuration. They are the -following: - -* - The user-specific configuration directory, containing the user-defined - settings is ``$GEANY_USER_CONFIG/plugins/geanygendoc/``. - ``$GEANY_USER_CONFIG`` is generally ``~/.config/geany/`` on UNIX systems. -* - The system-wide configuration directory containing the default and - pre-installed configuration is ``$GEANY_SYS_CONFIG/plugins/geanygendoc/``. - ``$GEANY_SYS_CONFIG`` is generally ``/usr/share/geany/`` or - ``/usr/local/share/geany`` on UNIX systems. - -When searching for configuration, GeanyGenDoc will first look in the -user's configuration directory, and if it wasn't successful, in the system -configuration directory. If both failed, it assumes that there is no -configuration at all. - - -Appendix -======== - -Configuration syntax summary ----------------------------- - -:: - - string ::= ( """ .* """ | "'" .* "'" ) - constant ::= [_A-Z][_A-Z0-9]+ - integer ::= [0-9]+ - boolean ::= ( "True" | "False" ) - setting_value ::= ( string | constant | integer ) - setting ::= "setting-name" "=" setting_value ";" - setting_list ::= ( "{" setting* "}" | setting ) - setting_section ::= "settings" "=" setting_list - - position ::= ( "BEFORE" | "AFTER" | "CURSOR" ) - policy ::= ( "KEEP" | "FORWARD" ) - children ::= ( "SPLIT" | "MERGE" ) - type ::= ( "class" | "enum" | "enumval" | "field" | - "function" | "interface" | "member" | "method" | - "namespace" | "package" | "prototype" | "struct" | - "typedef" | "union" | "variable" | "extern" | - "define" | "macro" | "file" ) - matches ::= type ( "|" type )* - doctype_subsetting ::= ( "template" "=" string | - "position" "=" position | - "policy" "=" policy | - "children" "=" children | - "matches" "=" matches | - "auto_doc_children" "=" boolean ) ";" - match ::= type ( "." type )* - doctype_setting ::= ( match "=" "{" doctype_subsetting* "}" | - match "." doctype_subsetting ) - doctype_setting_list ::= ( "{" doctype_setting* "}" | doctype_setting ) - doctype ::= "doctype-name" "=" doctype_setting_list - doctype_list ::= ( "{" doctype* "}" | doctype ) - doctype_section ::= "doctypes" "=" doctype_list - - document ::= ( setting_section? doctype_section? | - doctype_section? setting_section? ) - - -.. Content end, begin references - -.. External links -.. -.. _Doxygen: http://www.doxygen.org -.. _Gtk-Doc: http://www.gtk.org/gtk-doc/ -.. _Valadoc: http://www.valadoc.org/ -.. _CTPL: http://ctpl.tuxfamily.org/ - -.. Internal links -.. -.. _file type: `File types`_ -.. _file type configuration file: `File types`_ -.. _documentation type: `Documentation types`_ -.. _rule: `Rules: the cool thing`_ -.. _rules: `Rules: the cool thing`_ -.. _settings: `Rule settings`_ -.. _configuration directory: `Configuration directories`_ - -------------------- - -.. [default] This is the default value of the setting
Deleted: trunk/geanygendoc/po/LINGUAS =================================================================== --- trunk/geanygendoc/po/LINGUAS 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/po/LINGUAS 2010-12-21 18:18:10 UTC (rev 1780) @@ -1 +0,0 @@ -fr
Deleted: trunk/geanygendoc/po/POTFILES.in =================================================================== --- trunk/geanygendoc/po/POTFILES.in 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/po/POTFILES.in 2010-12-21 18:18:10 UTC (rev 1780) @@ -1,9 +0,0 @@ -src/ggd.c -src/ggd-doc-setting.c -src/ggd-doc-type.c -src/ggd-file-type.c -src/ggd-file-type-loader.c -src/ggd-file-type-manager.c -src/ggd-options.c -src/ggd-plugin.c -src/ggd-utils.c
Deleted: trunk/geanygendoc/po/fr.po =================================================================== --- trunk/geanygendoc/po/fr.po 2010-12-19 22:19:07 UTC (rev 1779) +++ trunk/geanygendoc/po/fr.po 2010-12-21 18:18:10 UTC (rev 1780) @@ -1,316 +0,0 @@ -# French translations for geanygendoc package -# Traductions françaises du paquet geanygendoc. -# Copyright (C) 2010 THE geanygendoc'S COPYRIGHT HOLDER -# This file is distributed under the same license as the geanygendoc package. -# Colomban Wendling ban@herbesfolles.org, 2010. -# -msgid "" -msgstr "" -"Project-Id-Version: geanygendoc 0.0.1\n" -"Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2010-04-27 00:54+0200\n" -"PO-Revision-Date: 2010-04-16 00:38+0200\n" -"Last-Translator: Colomban Wendling ban@herbesfolles.org\n" -"Language-Team: French\n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=UTF-8\n" -"Content-Transfer-Encoding: 8bit\n" -"Plural-Forms: nplurals=2; plural=(n > 1);\n" - -#: src/ggd.c:70 -#, c-format -msgid "Failed to resize memory output stream" -msgstr "Impossible de redimensionner le flux de sortie mémoire" - -#: src/ggd.c:98 -#, c-format -msgid "" -"Argument parsing regular expression did not match (argument list was: "%s")" -msgstr "" -"L'expression régulière d'analyse des arguments n'a pas correspondu (la liste " -"d'arguments était : « %s »)" - -#: src/ggd.c:231 -#, c-format -msgid "Failed to build comment: %s" -msgstr "Impossible de construire le commentaire : %s" - -#: src/ggd.c:400 -#, c-format -msgid "No documentation type "%s" for language "%s"" -msgstr "Pas de type de documentation « %s » pour le langage « %s »" - -#: src/ggd.c:493 -#, c-format -msgid "No valid tag for line %d" -msgstr "Pas de tag valide pour la ligne %d" - -#: src/ggd-file-type-loader.c:111 -msgid "boolean value" -msgstr "valeur booléenne" - -#: src/ggd-file-type-loader.c:124 -#, c-format -msgid "invalid boolean value "%s"" -msgstr "la valeur booléenne « %s » est invalide" - -#: src/ggd-file-type-loader.c:151 -#, c-format -msgid "invalid template: %s" -msgstr "modèle invalide : %s" - -#: src/ggd-file-type-loader.c:172 -msgid "position name" -msgstr "nom de position" - -#: src/ggd-file-type-loader.c:179 -#, c-format -msgid "invalid position "%s"" -msgstr "la position « %s » est invalide" - -#: src/ggd-file-type-loader.c:198 -msgid "policy name" -msgstr "nom de politique" - -#: src/ggd-file-type-loader.c:205 -#, c-format -msgid "invalid policy "%s"" -msgstr "la politique « %s » est invalide" - -#: src/ggd-file-type-loader.c:224 -msgid "merge policy" -msgstr "politique de fusion" - -#: src/ggd-file-type-loader.c:231 -#, c-format -msgid "invalid merge policy "%s"" -msgstr "la politique de fusion « %s » est invalide" - -#: src/ggd-file-type-loader.c:253 -msgid "type" -msgstr "type" - -#: src/ggd-file-type-loader.c:260 -#, c-format -msgid "invalid type "%s"" -msgstr "le type « %s » est invalide" - -#: src/ggd-file-type-loader.c:322 src/ggd-file-type-loader.c:770 -#, c-format -msgid "invalid setting name "%s"" -msgstr "" - -#: src/ggd-file-type-loader.c:343 src/ggd-file-type-loader.c:354 -#: src/ggd-file-type-loader.c:379 -msgid "setting identifier" -msgstr "" - -#: src/ggd-file-type-loader.c:425 -#, c-format -msgid "Unknown type "%s". Is this a typo?" -msgstr "Le type « %s » est inconnu. Est-ce une faute de frappe ?" - -#: src/ggd-file-type-loader.c:440 src/ggd-file-type-loader.c:484 -#: src/ggd-file-type-loader.c:496 src/ggd-file-type-loader.c:534 -msgid "match identifier" -msgstr "identifiant de correspondance" - -#: src/ggd-file-type-loader.c:448 -#, c-format -msgid "match is empty" -msgstr "la correspondance est vide" - -#: src/ggd-file-type-loader.c:466 -msgid "documentation type identifier" -msgstr "identifiant de type de documentation" - -#: src/ggd-file-type-loader.c:570 src/ggd-file-type-loader.c:581 -#: src/ggd-file-type-loader.c:602 -msgid "doctype" -msgstr "type de documentation" - -#: src/ggd-file-type-loader.c:636 -#, c-format -msgid "invalid regular expression: %s" -msgstr "expression régulière invalide : %s" - -#: src/ggd-file-type-loader.c:693 -#, c-format -msgid "invalid environment description: %s" -msgstr "description d'environnement invalide : %s" - -#: src/ggd-file-type-loader.c:730 src/ggd-file-type-loader.c:741 -#: src/ggd-file-type-loader.c:780 -msgid "setting" -msgstr "" - -#: src/ggd-file-type-loader.c:808 -msgid "section name" -msgstr "nom de section" - -#: src/ggd-file-type-loader.c:819 -#, c-format -msgid "duplicated section "%s"" -msgstr "la section « %s » est dupliquée" - -#: src/ggd-file-type-loader.c:828 -#, c-format -msgid "invalid section name "%s"" -msgstr "le nom de section « %s » est invalide" - -#: src/ggd-file-type-loader.c:841 src/ggd-file-type-loader.c:893 -#, c-format -msgid "input is empty" -msgstr "l'entrée est vide" - -#: src/ggd-file-type-loader.c:855 -#, c-format -msgid "Parsing warning: %s:%u:%u: %s" -msgstr "Avertissement d'analyse : %s:%u:%u : %s" - -#: src/ggd-file-type-loader.c:858 -#, c-format -msgid "Parsing error: %s:%u:%u: %s" -msgstr "Erreur d'analyse : %s:%u:%u : %s" - -#: src/ggd-file-type-loader.c:862 -#, c-format -msgid "%s:%u:%u: %s" -msgstr "%s:%u:%u : %s" - -#: src/ggd-file-type-manager.c:174 -#, c-format -msgid "Filetype configuration file for language "%s" not found: %s" -msgstr "" -"Le fichier de configuration du type de fichier pour le langage « %s » n'a pas " -"été trouvé : %s" - -#: src/ggd-file-type-manager.c:181 -#, c-format -msgid "Failed to load file type "%s" from file "%s": %s" -msgstr "" -"Impossible de charger le type de fichier « %s » depuis le fichier « %s » : %s" - -#: src/ggd-options.c:325 -msgid "Unknown setting" -msgstr "" - -#: src/ggd-options.c:334 -msgid "" -"Invalid option or proxy: either the proxy's property or the option type is " -"incompatible." -msgstr "" -"Option ou proxy invalide : la propriété du proxy ou le type de l'option est " -"incompatible." - -#: src/ggd-options.c:511 -#, c-format -msgid "Unknown value type for keyfile entry %s::%s" -msgstr "Type de valeur inconnue pour l'entrée de fichier de clé %s::%s" - -#: src/ggd-options.c:515 -#, c-format -msgid "Error retrieving keyfile entry %s::%s: %s" -msgstr "" -"Erreur lors de la récupération de l'entrée de fichier de clé %s::%s : %s" - -#: src/ggd-plugin.c:51 -msgid "Generates documentation comments basis from source code" -msgstr "" -"Génères des bases de commentaires de documentation depuis le code source" - -#: src/ggd-plugin.c:155 -#, c-format -msgid "Failed to load configuration: %s" -msgstr "Impossible de charger la configuration : %s" - -#: src/ggd-plugin.c:176 -#, c-format -msgid "Failed to save configuration: %s" -msgstr "Impossible d'enregistrer la configuration : %s" - -#: src/ggd-plugin.c:247 -#, c-format -msgid "Failed to find configuration file for file type "%s": %s" -msgstr "" -"Impossible de trouver le fichier de configuration pour le type de fichier « %" -"s » : %s" - -#: src/ggd-plugin.c:301 src/ggd-plugin.c:312 -msgid "Insert documentation comment" -msgstr "Insérer un commentaire de documentation" - -#. build "document current symbol" item -#: src/ggd-plugin.c:338 -msgid "_Document current symbol" -msgstr "_Documenter le symbole courant" - -#: src/ggd-plugin.c:339 -msgid "Generate documentation for the currently selected symbol" -msgstr "Générer la documentation pour le symbole sélectionné" - -#. build "document all" item -#: src/ggd-plugin.c:346 -msgid "Document _all symbols" -msgstr "Documenter _tous les symboles" - -#: src/ggd-plugin.c:347 -msgid "Generate documentation for all the symbols in the current document" -msgstr "Générer la documentation pour tous les symboles du fichier courant" - -#. build "reload" item -#: src/ggd-plugin.c:357 -msgid "_Reload configuration files" -msgstr "_Recharger les fichiers de configuration" - -#: src/ggd-plugin.c:358 -msgid "Force reloading of the configuration files" -msgstr "Forcer le rechargement des fichiers de configuration" - -#. language filetypes opener -#: src/ggd-plugin.c:367 -msgid "_Edit current language configuration" -msgstr "Édit_er la configuration du langage courant" - -#: src/ggd-plugin.c:368 -msgid "Open the current language configuration file for editing" -msgstr "Ouvrir le fichier de configuration du langage courant pour l'éditer" - -#. build tools menu item -#: src/ggd-plugin.c:375 -msgid "_Documentation generator"
@@ Diff output truncated at 100000 characters. @@
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.