Add phpdoc to properties

[vminakov]

Modern IDEs are able parse @phpdoc comments to allow smart code completition. This is very useful and helpful feature, especially when developing plugins for Roundcube, which provides large API.

Roundcube lacks proper phpdoc comments for properties. For example, following @phpdoc comment in rcmail class would trigger code completition for rcube_template, if developers type rcmail::get_instance()->output-> in their plugins:

<?php
/**
 * Stores template.
 *
 * @var rcmail_template
 */
 public $output;
...

The same applies to methods: they return instances of rcube_user or rcube_template, however @phpdocs for these methods say they're returning just "object".

[alec]

We're open for patches.

[vminakov]

First patch attached. Affected files:

program/include/main.inc
program/include/rcmail.php
program/include/rcube_contacts.php
program/include/rcube_html_page.php
program/include/rcube_json_output.php
program/include/rcube_message.php
program/include/rcube_plugin.php
program/include/rcube_plugin_api.php
program/include/rcube_user.php

I'll keep working on other files.

[vminakov]

Updated the patch. Based on [cb3dfdfe].

Updated files:
program/include/html.php
program/include/rcube_addressbook.php
program/include/rcube_config.php
program/include/rcube_imap.php
program/include/rcube_mdb2.php

[alec]

Applied in [5c461bad].