Difference between revisions of "Dev:Contribute to Code"
From Synfig Studio :: Documentation
m (typos) |
|||
| Line 2: | Line 2: | ||
== Introduction == | == Introduction == | ||
| − | You should know by the [[History|history]] | + | You should know by the [[History|history]], that this program was initially written by an animation company, [[History|Voria Studios]]. Since the code of Synfig was released under [[License|GPL licence]] and turned into an open source project, there have been made some modifications to the code, which allows you to remove bugs and to add some new functionality. |
| − | + | ||
| − | + | ||
| − | Feel free to add here all the information you can | + | The only documentation you can get, is the source-code itself and the automatically generated [http://synfig.org/api/ API docs] by [http://www.doxygen.org doxygen]. |
| + | This page tries to collect all the knowledge acquired by the current developers and to create typical guides for common tasks which would allow you to add new features and make the program grow. | ||
| + | |||
| + | Feel free to add here all the information you can get from the experience of reading and modifying the source code or simply add your request to get more details from coders more familiar with the source. Hopefully they will be able to tell you, how it works and where to dive in. | ||
== Common tasks == | == Common tasks == | ||
| − | * [[Source:Adding a Layer|Adding Layers to Synfig]]: this guide | + | * [[Source:Adding a Layer|Adding Layers to Synfig]]: this guide aids you to understand, how the layers work and how to add a new layer type. |
| − | * [[Source:Adding a Panel-Part I| Adding Panels to Synfigstudio]]: This guide | + | * [[Source:Adding a Panel-Part I| Adding Panels to Synfigstudio]]: This guide explains, how to add a new panel and the objects on it. |
== Things you want to know about the code == | == Things you want to know about the code == | ||
| − | * Please add here a brief description of the things you want to know about the code and how to accomplish some task. | + | * Please add here a brief description of the things you want to know about the code and how to accomplish some task. Someone else will surely know it, and can help you to start developing on synfig. |
* Is there anywhere any kind of overview? Any sort of brief description of what each program does/is? Is synfigstudio the GUI for synfig? What's the ETL? | * Is there anywhere any kind of overview? Any sort of brief description of what each program does/is? Is synfigstudio the GUI for synfig? What's the ETL? | ||
| Line 21: | Line 22: | ||
==Documenting the code == | ==Documenting the code == | ||
| − | It would be a good thing | + | It would be a good thing, if all the code documentation and what is being discovered were confirmed and inserted directly in the source code itself. This would allow [http://www.doxygen.org doxygen] to generate the [http://synfig.org/api/ API docs] easily. |
Please follow these [http://www.stack.nl/~dimitri/doxygen/docblocks.html doxygen rules] to add documentation to the source code. | Please follow these [http://www.stack.nl/~dimitri/doxygen/docblocks.html doxygen rules] to add documentation to the source code. | ||
Revision as of 23:10, 26 April 2008
Contents
Introduction
You should know by the history, that this program was initially written by an animation company, Voria Studios. Since the code of Synfig was released under GPL licence and turned into an open source project, there have been made some modifications to the code, which allows you to remove bugs and to add some new functionality.
The only documentation you can get, is the source-code itself and the automatically generated API docs by doxygen. This page tries to collect all the knowledge acquired by the current developers and to create typical guides for common tasks which would allow you to add new features and make the program grow.
Feel free to add here all the information you can get from the experience of reading and modifying the source code or simply add your request to get more details from coders more familiar with the source. Hopefully they will be able to tell you, how it works and where to dive in.
Common tasks
- Adding Layers to Synfig: this guide aids you to understand, how the layers work and how to add a new layer type.
- Adding Panels to Synfigstudio: This guide explains, how to add a new panel and the objects on it.
Things you want to know about the code
- Please add here a brief description of the things you want to know about the code and how to accomplish some task. Someone else will surely know it, and can help you to start developing on synfig.
- Is there anywhere any kind of overview? Any sort of brief description of what each program does/is? Is synfigstudio the GUI for synfig? What's the ETL?
Documenting the code
It would be a good thing, if all the code documentation and what is being discovered were confirmed and inserted directly in the source code itself. This would allow doxygen to generate the API docs easily.
Please follow these doxygen rules to add documentation to the source code.
