Fixes #10 : documentation clean-up post refactor.
Note that phpDocumentor2 is generating a host of spurious errors in my
environment which may be hiding actual issues. The generated HTML also has
issues in chrome which make it hard to browse and that also may be covering up
problems in this commit.
However, I cleaned up and fixed a number of doc-comment issues, ensured that
most methods/properties had reasonable descriptions and noted preconditions.
Eclipse is browsing the comments and picking up on type hints without the
problems phpDocumentor2 is showing.
I also updated the README.
Added assertions to enforce preconditions defined in doc comments. Tweaked doc
comments.
Fix #1 : UID is now a single-value element.
Bitmap version of svg.
Documenting current class relationships.
Added link to Wiki.
Corrected typo from previous commit.
Ignore netbeans project files.
Minor corrections to test cases.
Fixed typo causing uninitialized variable.
Puzzled out the behavior of adr and types. Added a test case.
The current code 'works' but the behavior is *extremely* opaque and very
fragile. Using __call(..) to set typed and un-typed values ends up committing
very unnatural acts and requires code trying to puzzle out the values on the
other end (say when we try to save types in vCardDB...) to be almost
incomprehensible.
Fixed issue with behavior of Type parameter on structured properties such as
ADR. Type is now set as simply another field of the property and appears in the
array alongside those values. This is consistent with existing behavior when
importing structured properties. See discussion in #2 .
Fixes #2 : Now storing/retrieving TYPE parameters for structured properties
(specifically ADR, ORG). org is now a typed-property in vCard. Added methods to
associate and fetch type values for structured properties vCardDB handles.
Testcase verifies for ADR. Cleaned up existing Address testcase.
Added the top-level Vendor Namespace EVought to comply with PSR-4.
Changed vCard classname to VCard StudlyCase to conform with PSR-1.
Renamed vcard.php to VCard.php to conform to PSR-4.
Corrected bad case in namespace declaration from earlier commit.
Renamed vcard-db.php to VCardDB.php to conform with PSR-4.
Renamed vcard-templates.php to Template.php to conform with PSR-4.
Renamed VCardTemplatesTest to conform to conventions.
Modified build to generate docs against correct files post renames.