pt-br:dev

C/C++ Code Style for NCL Composer

2017-02-03T16:31:18-03:00

This page is a draft!

C/C++ Code Style for NCL Composer

As any project, keep code standard is important to improve the quality of the software, improve reusability and a software which is easier to maintain.

The NCL Composer Code style is similar to most of the C++ projects. So, you will easily navigate through the source code. Here, we will discuss some issues of our code style.

Class Template

The following code shows an template that should be followed when defining a class:

namespace composer {
    namespace core {
        namespace model {
/*!
 \brief Description of the class
 */
class MyClass
{
// Class Content
};
 
} } } //end namespace

It is recommended to keep the final comment informing that line is finishing the namespace.

Colabore

2017-02-03T16:31:18-03:00

Colabore

NCL Composer é um projeto de código livre, portanto, estamos sempre abertos para quaisquer contribuições.

Se você não é programador, você também pode contribuir com o NCL Composer:

Mas, se você é programador você pode contribuir também com o código-fonte do NCL Composer. Veja as páginas seguintes para mais informações:

Além disso, você também pode extender o NCL Composer:

Desenvolvendo seu próprio plugin

Planejamento para a próxima versão

2017-02-03T16:31:18-03:00

Planejamento para a próxima versão

Esta página está desatualizada.

<todo #>Definição da API de plugins.</todo>
<todo #>Implementação do núcleo do NCL Composer.</todo>
<todo #>Interface gráfica do usuário - NCL Composer</todo>
- <todo>Integração com o Clube NCL.</todo>
Plugins para o pacote básico:
- <todo #>Visão de Leiaute</todo>
- <todo>Visão estrutural</todo>
- <todo #>Visão de Outline</todo>
- <todo #>Visão de Propriedades</todo>
- <todo>Visão Textual</todo>
- <todo #>Plugin Validador NCL (desenvolvido por Laws/UFMA)</todo>

A fazer (versões futuras)

Plugin de script Lua (habilitando ao usuário escrever diretamente códigos lua ou importar a partir de arquivos existentes.)
Separação de cada plugin como um processo diferente.
Suporte à importação de documentos.

Sugestões?

Contate-nos para sugerir novas funcionalidades.

Submitting a patch to NCL Composer

2017-02-03T16:31:18-03:00

Submitting a patch to NCL Composer

You can submit a patch directly to our Mailing List (go to contact page for more information).

The easier way to create a patch is using the git features. We recommend you create a new branch and hack whatever you want in this local branch. This way, you can commit your changes locally and even keep track of your local changes easily.

Let's say you want to changes some code in the composer-core project. First you need to clone the repository and then create your own local branch:

$ git clone git://git.telemidia.puc-rio.br/composer-core.git
$ cd composer-core
$ git checkout -b myfix_to_composer

Now, you can change whatever you want and commit your changes to your myfix_to_composer local branch.

When you are done, you can create a new patch with the following command:

$ git format-patch master --stdout > mypatch.patch

Now, send us this mypatch.patch file.

You can also, send this patch directly from git, using git send-email command:

$ git send-email --to=composer-dev@telemidia.puc-rio.br mypatch.patch