Commit 8d91e674 authored by Loïc Correnson's avatar Loïc Correnson
Browse files

[ivette] fix doc links

parent 4fe5790f
......@@ -183,7 +183,7 @@ export function getKeys<T>(a: T): (keyof T)[] {
/**
Maps each field of `A` to some _optional_ comparison of the associated type.
Hence, `ByFields<{…, f: T, …}>` is `{…, f?: Order<T>, …}`.
See [[fields]] comparison function.
See [[byFields]] comparison function.
*/
export type ByFields<A> = {
[P in keyof A]?: Order<A[P]>;
......@@ -192,7 +192,7 @@ export type ByFields<A> = {
/**
Maps each field of `A` to some comparison of the associated type.
Hence, `ByAllFields<{…, f: T, …}>` is `{…, f: Order<T>, …}`.
See [[fieldsComplete]] comparison function.
See [[byAllFields]] comparison function.
*/
export type ByAllFields<A> = {
[P in keyof A]: Order<A[P]>;
......
......@@ -96,7 +96,7 @@ export function useState<A>(s: State<A>): [A, (update: A) => void] {
shall always be used with the same « role » otherwise it is discarded,
and an error message is logged when in DEVEL mode.
*/
abstract class Settings<A> {
export abstract class Settings<A> {
private static keyRoles = new Map<string, symbol>();
......@@ -106,7 +106,7 @@ abstract class Settings<A> {
/**
Encoders shall be protected against exception.
Use [[JSON.jTry]] and [[JSON.jCatch]] in case of uncertainty.
Use [[dome/data/json.jTry]] and [[dome/data/json.jCatch]] in case of uncertainty.
Decoders are automatically protected internally to the Settings class.
@param role Debugging name of instance roles (each instance has its unique
role, though)
......@@ -217,7 +217,7 @@ export function useSettings<A>(
/** Window Settings for non-JSON data.
In most situations, you can use [[WindowSettings]] instead.
You can use a [[JSON.Loose]] decoder for optional values. */
You can use a [[dome/data/json.Loose]] decoder for optional values. */
export class WindowSettingsData<A> extends Settings<A> {
constructor(
......@@ -237,7 +237,7 @@ export class WindowSettingsData<A> extends Settings<A> {
/** Global Settings for non-JSON data.
In most situations, you can use [[WindowSettings]] instead.
You can use a [[JSON.Loose]] decoder for optional values. */
You can use a [[dome/data/json.Loose]] decoder for optional values. */
export class GlobalSettingsData<A> extends Settings<A> {
constructor(
......@@ -256,8 +256,8 @@ export class GlobalSettingsData<A> extends Settings<A> {
}
/** Window Settings.
For non-JSON data, use [[WindowSettingsdata]] instead.
You can use a [[JSON.Loose]] decoder for optional values. */
For non-JSON data, use [[WindowSettingsData]] instead.
You can use a [[dome/data/json.Loose]] decoder for optional values. */
export class WindowSettings<A extends JSON.json> extends WindowSettingsData<A> {
constructor(role: string, decoder: JSON.Safe<A>, fallback?: A) {
......@@ -267,8 +267,8 @@ export class WindowSettings<A extends JSON.json> extends WindowSettingsData<A> {
}
/** Global Settings.
For non-JSON data, use [[WindowSettingsdata]] instead.
You can use a [[JSON.Loose]] decoder for optional values. */
For non-JSON data, use [[WindowSettingsData]] instead.
You can use a [[dome/data/json.Loose]] decoder for optional values. */
export class GlobalSettings<A extends JSON.json> extends GlobalSettingsData<A> {
constructor(role: string, decoder: JSON.Safe<A>, fallback?: A) {
......
......@@ -166,7 +166,7 @@ export class ArrayModel<Key, Row>
comparison for un-specified columns are kept unchanged, if any.
This will be used to refine
[[setNaturalOrder]] in response to user column selection with
[[setSortBy]] provided you enable by-column sorting from the table view.
[[setSorting]] provided you enable by-column sorting from the table view.
Finally triggers a reload. */
setColumnOrder(columns?: ByColumns<Row>) {
this.columns = { ...this.columns, ...columns };
......@@ -176,7 +176,7 @@ export class ArrayModel<Key, Row>
/** Sets natural ordering of the rows.
It defines in which order the entries are rendered in the table. This
primary ordering can be refined in response to user column selection with
[[setSortBy]] provided you enable by-column sorting from the table view.
[[setSorting]] provided you enable by-column sorting from the table view.
Finally triggers a reload. */
setNaturalOrder(order?: Order<Row>) {
this.natural = order;
......@@ -186,7 +186,7 @@ export class ArrayModel<Key, Row>
/**
Sets both natural ordering and column ordering with the provided
orders by fields. This is a combination of [[setColumnOrder]] and
[[setNaturalOrder]] with [[Compare.byFields]].
[[setNaturalOrder]] with [[dome/data/compare.byFields]].
*/
setOrderingByFields(byfields: ByFields<Row>) {
this.natural = Compare.byFields(byfields);
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment