Dev:Contribute to Code

From Synfig Studio :: Documentation
Revision as of 22:38, 26 April 2008 by Evilkillerfiggin (Talk | contribs)

Jump to: navigation, search


You should know by the history if this program that initially the code was written by an animation company, Voria Studios. Since the code of Synfig was released under GPL licence and turned to a open source project, there have been some modifications to the code that has allowed to remove a lot of bugs mainly and to add some new functionality. The only documentation you can have about the source is the code itself and the automatically generated API docs by doxygen. This page try to collects all the knowledge acquired by the current developers and create typical guides for common tasks which would allow to add new features and make the program grow.

Feel free to add here all the information you can grab from the experience of read and modify the source code or simply add your request to understand how do the code accomplish certain tasks.

Common tasks

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. Maybe someone other know it and can help you and all the rest of potential code developers to do that task.
  • 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 that all the code documentation and that is being discovered were confirmed and inserted in the source code itself. This would allow doxygen generate the API docs easily.

Please follow these doxygen rules to add documentation to the source code.