umberto 2.3.1 → 2.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umberto",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "CKSource Documentation builder",
   "main": "src/index.js",
   "files": [
@@ -56,10 +56,10 @@
     "webpack": "^5.74.0"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-dev-bump-year": "^32.0.1",
-    "@ckeditor/ckeditor5-dev-ci": "^32.0.1",
-    "@ckeditor/ckeditor5-dev-docs": "^32.0.1",
-    "@ckeditor/ckeditor5-dev-release-tools": "^32.0.1",
+    "@ckeditor/ckeditor5-dev-bump-year": "^34.0.0",
+    "@ckeditor/ckeditor5-dev-ci": "^34.0.0",
+    "@ckeditor/ckeditor5-dev-docs": "^34.0.0",
+    "@ckeditor/ckeditor5-dev-release-tools": "^34.0.0",
     "browser-sync": "^2.27.10",
     "chai": "^4.3.6",
     "chokidar": "^3.5.3",

package/src/api-builder/classes/description-parser.js

@@ -177,9 +177,73 @@ module.exports = class DescriptionParser {
 				member = name;
 			}
 
-			const targetDoclet = findTargetDoclet( this._dataCollection, { module, structure, member, label, query } );
+			let targetDoclet = findTargetDoclet( this._dataCollection, { module, structure, member, label, query } );
 			let replaceToPhrase;
 
+			if ( !targetDoclet && options.parentDoclet ) {
+				const augmentsNested = [
+					// If looking for a property, check if it is defined in a derived class, e.g.,
+					//
+					// ```ts
+					// class A {
+					// 	public foo: any;
+					//
+					// 	/**
+					// 	 * See {@link ~A#foo}.
+					// 	 */
+					// 	public getFoo(): void;
+					// }
+					// class B extends A {
+					// }
+					// ```
+					//
+					// `B` contains the property, so from its perspective, the link is valid.
+					// Let's try to parse it as it would be specified as `~B#foo`.
+					options.parentDoclet.longname,
+
+					// When looking for a structure withing the same module, check parent classes, e.g.,
+					//
+					// ```ts
+					// class A {
+					// 	/**
+					// 	 * See {@link ~A}.
+					// 	 */
+					// 	public getFoo(): void;
+					// }
+					// class B extends A {
+					// }
+					// ```
+					//
+					// `~A` seeing from a module containing the `B` class does not make sense.
+					// Let's try to find the proper doclet in parent classes.
+					...( options.parentDoclet.augmentsNested || [] )
+				];
+
+				targetDoclet = augmentsNested
+					.map( augmentName => {
+						const splitResult = splitLongname( augmentName );
+
+						let structure = [
+							`module:${ splitResult.packageName }`,
+							...splitResult.directoryNames,
+							splitResult.moduleName
+						].join( '/' );
+
+						// When `name` and `className` are equal, we look for a `member` in the `${ structure }~${ className }` doclet.
+						if ( splitResult.name === splitResult.className ) {
+							structure += `~${ splitResult.className }`;
+						}
+
+						return findTargetDoclet( this._dataCollection, {
+							structure,
+							member,
+							label,
+							query
+						} );
+					} )
+					.find( Boolean );
+			}
+
 			if ( targetDoclet ) {
 				let href;
 

package/src/data-converter/converters/typedoc/constructorparser.js

@@ -22,6 +22,11 @@ module.exports = class ConstructorParser extends MethodParser {
 	 * @returns {Array.<Object>}
 	 */
 	parse( item, parentName ) {
+		// Absence of sources means that the actual class does not have a constructor.
+		if ( !item.sources ) {
+			return null;
+		}
+
 		const results = super.parse( item, parentName );
 
 		for ( const item of results ) {

package/src/data-converter/converters/typedoc/propertyparser.js

@@ -50,11 +50,32 @@ module.exports = class PropertyParser extends AbstractParser {
 			deprecated: this.isDeprecated( item ),
 			inherited: !!item.inheritedFrom,
 			see: this.getRelated( item, parentName ),
+			defaultvalue: this.getDefault( item ),
 
 			// This property will be filled in the post-processing phase.
 			type: null
 		};
 	}
+
+	/**
+	 * Returns the default value of an item defined by the `@defaultValue` or `@default` tags.
+	 *
+	 * @param {TypedocReflection} item
+	 * @returns {String}
+	 */
+	getDefault( item ) {
+		if ( !item.comment || !item.comment.blockTags ) {
+			return null;
+		}
+
+		const defaultTag = item.comment.blockTags.find( blockTag => blockTag.tag === '@defaultValue' || blockTag.tag === '@default' );
+
+		if ( !defaultTag ) {
+			return null;
+		}
+
+		return defaultTag.content[ 0 ].text;
+	}
 };
 
 /**