Updated doc blocks to add missing pieces and rebuild the documentation

Author: bseddon

XBRL-Constants.php

@@ -984,8 +984,17 @@ function( $qname ) { return XBRL::endsWith( $qname->localName, 'Link' ); }
 	 * Severity values
 	 * -----------------------------------------------------------------------------
 	 */
+	/**
+	 * @var string Returns 'OK'
+	 */
 	public static $severityOK = ASSERTION_SEVERITY_OK;
+	/**
+	 * @var string Returns 'ERROR'
+	 */
 	public static $severityERROR = ASSERTION_SEVERITY_ERROR;
+	/**
+	 * @var string Returns 'WARNING'
+	 */
 	public static $severityWARNING = ASSERTION_SEVERITY_WARNING;
 
 	/* -----------------------------------------------------------------------------

XBRL-Global.php

@@ -320,6 +320,7 @@ public function getTaxonomyWithPrefix( $prefix )
 	/**
 	 * Create a path to the parallel folder for a url
 	 * @param string $url
+	 * @param string $cacheLocation
 	 * @return string
 	 */
 	public static function createPathFromUrl( $url, $cacheLocation )

XBRL-Instance.php

@@ -5723,11 +5723,15 @@ private function validateTypedMembers( $component, $contextId, $types, $componen
 			// 3.1.4.4.3 (1) Should be checked when reading the context
 			// 3.1.4.4.3 (2) Should be checked when validaing the fact value
 
-			$typeElement = $types->getElement( $type );
+			// Need to map the local prefix to the source taxonomy prefix
+			$parts = explode( ":", $type );
+			$parts[0] = $this->normalizePrefix( $parts[0] );
+			$typeElement = $types->getElement( implode( ":", $parts ) );
 			if ( ! $typeElement ||
 				 ! count( $typeElement['types'] )
 			)
 			{
+				$x = 1;
 				$this->log()->dimension_validation(
 					"3.1.4.4.3",
 					"The type element of the member MUST be defined by the schema document",

XBRL-Package.php

@@ -140,6 +140,7 @@ public static function fromZip( ZipArchive $zipArchive, $className )
 	}
 
 	/**
+	 * A reference to the archive hosting the package
 	 * @var ZipArchive $zipArchive
 	 */
 	private $zipArchive;
@@ -267,6 +268,7 @@ public function isPackage() {}
 	/**
 	 * Returns true if the taxonomy in the package is compiled
 	 * @param string $compiledDir Path to the compiled taxonomies folder
+	 * @param string $basename Specifies an explicit basename.  Otherwise the basename of the schema name is used.
 	 * @return bool
 	 */
 	public function isCompiled( $compiledDir, $basename = null )
@@ -615,8 +617,7 @@ protected function getTargetNamespace( $schemaName, $content, $throwException =
 
 	/**
 	 * Processes the schema document in a consistent way
-	 * @param \XBRL_Global A reference to the global context
-	 * @param string $schemaName Name of the schema represented by $content
+	 * @param \XBRL_Global $context A reference to the global context
 	 * @param bytes $content Expected to be an XML schema
 	 * @param bool $throwException True if an exception should be thrown on error or false is returned otherwise
 	 * @return bool
@@ -678,6 +679,9 @@ protected function processSchemaDocument( $context, $content, $throwException =
 
 	/**
 	 * Implements a Url map that allows a simple xsd name to map to a path that can be found in the cache
+	 * @param string $schemaNamespace
+	 * @param string $schemaFile
+	 * @throws Exception
 	 */
 	protected function setUrlMap( $schemaNamespace = null, $schemaFile = null )
 	{
@@ -719,7 +723,7 @@ protected function setUrlMap( $schemaNamespace = null, $schemaFile = null )
 
 	/**
 	 * Returns the schema file base name without the extension
-	 * @param string $extension
+	 * @param string $replacementExtension
 	 * @return string
 	 */
 	public function getSchemaFileBasename( $replacementExtension = "")

XBRL-SEC-JSON-Package.php

@@ -221,6 +221,11 @@ public function getFile( $path )
 		return parent::getFile( $this->getActualUri( $path ) );
 	}
 
+	/**
+	 * Returns a localized version of the schema file path
+	 * @param string $uri
+	 * @return string
+	 */
 	public function getActualUri( $uri )
 	{
 		return basename( $uri );

XBRL-SEC-XML-Package.php

@@ -147,7 +147,7 @@ private function isValidMetaFile()
 
 	/**
 	 * Grab the values from the XML
-	 * @param SimpleXMLElement $element
+	 * @param SimpleXMLElement $elements
 	 */
 	private function processElement( $elements )
 	{

XBRL-TaxonomyPackage.php

@@ -71,7 +71,7 @@ class XBRL_TaxonomyPackage extends XBRL_Package
 	const metaFolderName = "META-INF";
 
 	/**
-	 *
+	 * A reference to the catalog in the package
 	 * @var SimpleXMLElement
 	 */
 	private $catalog;
@@ -598,6 +598,11 @@ protected function determineSchemaFile()
 		}
 	}
 
+	/**
+	 * Returns a localized version of the schema file path
+	 * @param string $uri
+	 * @return string
+	 */
 	protected function getActualUri( $uri )
 	{
 		foreach ( $this->rewriteURIs as $prefix => $rewriteUri )

XBRL.php

@@ -45,6 +45,12 @@
 
 if ( ! function_exists("__") )
 {
+	/**
+	 * A polyfill for the getText __() function
+	 * @param string $message
+	 * @param string $domain
+	 * @return string
+	 */
 	function __( $message, $domain )
 	{
 		return "$message\n";
@@ -5950,6 +5956,8 @@ public function getGenericLabel( $searchRole, $searchLabel = null, $searchLang =
 	 * 									such as 'fact' for 'variable' or 'formula' for 'variableset'
 	 * 									If null then any resource of the type $resourceType will be returned.
 	 * @param Function $callback			(optional) A callback to process results (see below)
+	 * @param string $roleUri
+	 * @param string $label
 	 * @return boolean|array[]
 	 *
 	 * Callback will return true if no further processing is required. The arguments passed to the callback are:
@@ -17558,6 +17566,11 @@ public static function findDimensionMember( $nodes, $label )
 		return false;
 	}
 
+	/**
+	 * Strips out and resolves ./ and ../ parts of the string
+	 * @param string $path
+	 * @return mixed
+	 */
 	public static function normalizePath($path)
 	{
 		// Test this function using these paths

documentation.zip

@@ -2,21 +2,31 @@
 
 /**
  * An log observer used to capture taxonomy validation messages so they can be reported by the app
+ *  _					   _	 _ _ _
+ * | |   _   _  __ _ _   _(_) __| (_) |_ _   _
+ * | |  | | | |/ _` | | | | |/ _` | | __| | | |
+ * | |__| |_| | (_| | |_| | | (_| | | |_| |_| |
+ * |_____\__, |\__, |\__,_|_|\__,_|_|\__|\__, |
+ *	     |___/	  |_|					 |___/
  *
  * @author Bill Seddon
  * @version 1.0
  * @Copyright (C) 2018 Lyquidity Solutions Limited
  * @License: GPL 3.0
  *
  */
+
 namespace lyquidity\dfb;
 
 /**
  * Implementation of a log observer
  */
 class Observer extends \Log_observer
 {
-	// A list of any issue found
+	/**
+	 * A list of any issue found
+	 * @var array
+	 */
 	private $issues = array();
 
 	/**
@@ -45,7 +55,7 @@ public function notify( $event )
 
 	/**
 	 * Add extra entries into the session
-	 * @param string $section
+	 * @param string $name
 	 * @param array $data
 	 */
 	public function addItem( $name, $data )