Proposed simplified docblock

This commit is contained in:
Ivan Lanin 2014-03-26 17:21:23 +07:00
parent 72bb688020
commit a6568e988b
2 changed files with 39 additions and 22 deletions

View File

@ -2,23 +2,9 @@
/**
* PHPWord
*
* Copyright (c) 2014 PHPWord
* PHP version 5.3
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* @copyright Copyright (c) 2014 PHPWord
* @copyright 2014 PHPWord
* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
* @version 0.9.0
*/

View File

@ -1,4 +1,14 @@
<?php
/**
* PHPWord
*
* PHP version 5.3
*
* @copyright 2014 PHPWord
* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
* @version 0.9.0
*/
namespace PhpOffice\PhpWord\Tests;
use PhpOffice\PhpWord\PhpWord;
@ -7,13 +17,16 @@ use PhpOffice\PhpWord\Section;
use PhpOffice\PhpWord\Style;
/**
* Test for PHPWord main class
*
* @coversDefaultClass \PhpOffice\PhpWord\PhpWord
* @runTestsInSeparateProcesses
*/
class PhpWordTest extends \PHPUnit_Framework_TestCase
{
/**
* @covers ::__construct
* Test object creation
*
* @covers ::getDocumentProperties
* @covers ::getDefaultFontName
* @covers ::getDefaultFontSize
@ -27,6 +40,8 @@ class PhpWordTest extends \PHPUnit_Framework_TestCase
}
/**
* Test set/get document properties
*
* @covers ::setDocumentProperties
* @covers ::getDocumentProperties
*/
@ -41,6 +56,8 @@ class PhpWordTest extends \PHPUnit_Framework_TestCase
}
/**
* Test create/get section
*
* @covers ::createSection
* @covers ::getSections
*/
@ -53,6 +70,8 @@ class PhpWordTest extends \PHPUnit_Framework_TestCase
}
/**
* Test set/get default font name
*
* @covers ::setDefaultFontName
* @covers ::getDefaultFontName
*/
@ -66,6 +85,8 @@ class PhpWordTest extends \PHPUnit_Framework_TestCase
}
/**
* Test set/get default font size
*
* @covers ::setDefaultFontSize
* @covers ::getDefaultFontSize
*/
@ -79,6 +100,8 @@ class PhpWordTest extends \PHPUnit_Framework_TestCase
}
/**
* Test set default paragraph style
*
* @covers ::setDefaultParagraphStyle
* @covers ::loadTemplate
*/
@ -90,6 +113,8 @@ class PhpWordTest extends \PHPUnit_Framework_TestCase
}
/**
* Test add styles
*
* @covers ::addParagraphStyle
* @covers ::addFontStyle
* @covers ::addTableStyle
@ -114,6 +139,8 @@ class PhpWordTest extends \PHPUnit_Framework_TestCase
}
/**
* Test add title style
*
* @covers ::addTitleStyle
*/
public function testAddTitleStyle()
@ -126,6 +153,8 @@ class PhpWordTest extends \PHPUnit_Framework_TestCase
}
/**
* Test load template
*
* @covers ::loadTemplate
*/
public function testLoadTemplate()
@ -140,6 +169,8 @@ class PhpWordTest extends \PHPUnit_Framework_TestCase
}
/**
* Test load template exception
*
* @covers ::loadTemplate
* @expectedException \PhpOffice\PhpWord\Exceptions\Exception
*/
@ -147,7 +178,7 @@ class PhpWordTest extends \PHPUnit_Framework_TestCase
{
$templateFqfn = \join(
\DIRECTORY_SEPARATOR,
array(\PHPWORD_TESTS_BASE_DIR, 'PhpWord', 'Tests', 'data', 'templates', 'blanks.docx')
array(\PHPWORD_TESTS_BASE_DIR, 'PhpWord', 'Tests', '_files', 'templates', 'blanks.docx')
);
$phpWord = new PhpWord();
$phpWord->loadTemplate($templateFqfn);