Remove redundant documentation After migrating to typescript the parameters that are optional or required can be determined by the method signature. Unclear parameters should have a comment near the method instead. Change-Id: I3283e2826c61f9d4f9283e2c2584c7fb8a7eb097
diff --git a/polygerrit-ui/app/elements/core/gr-navigation/gr-navigation.ts b/polygerrit-ui/app/elements/core/gr-navigation/gr-navigation.ts index fcc853d..e5340fa 100644 --- a/polygerrit-ui/app/elements/core/gr-navigation/gr-navigation.ts +++ b/polygerrit-ui/app/elements/core/gr-navigation/gr-navigation.ts
@@ -40,65 +40,7 @@ // // Each object has a `view` property with a value from GerritNav.View. The // remaining properties depend on the value used for view. -// -// - GerritNav.View.CHANGE: -// - `changeNum`, required, String: the numeric ID of the change. -// - `project`, optional, String: the project name. -// - `patchNum`, optional, Number: the patch for the right-hand-side of -// the diff. -// - `basePatchNum`, optional, Number: the patch for the left-hand-side -// of the diff. If `basePatchNum` is provided, then `patchNum` must -// also be provided. -// - `edit`, optional, Boolean: whether or not to load the file list with -// edit controls. -// - `messageHash`, optional, String: the hash of the change message to -// scroll to. -// -// - GerritNav.View.SEARCH: -// - `query`, optional, String: the literal search query. If provided, -// the string will be used as the query, and all other params will be -// ignored. -// - `owner`, optional, String: the owner name. -// - `project`, optional, String: the project name. -// - `branch`, optional, String: the branch name. -// - `topic`, optional, String: the topic name. -// - `hashtag`, optional, String: the hashtag name. -// - `statuses`, optional, Array<String>: the list of change statuses to -// search for. If more than one is provided, the search will OR them -// together. -// - `offset`, optional, Number: the offset for the query. -// -// - GerritNav.View.DIFF: -// - `changeNum`, required, String: the numeric ID of the change. -// - `path`, required, String: the filepath of the diff. -// - `patchNum`, required, Number: the patch for the right-hand-side of -// the diff. -// - `basePatchNum`, optional, Number: the patch for the left-hand-side -// of the diff. If `basePatchNum` is provided, then `patchNum` must -// also be provided. -// - `lineNum`, optional, Number: the line number to be selected on load. -// - `leftSide`, optional, Boolean: if a `lineNum` is provided, a value -// of true selects the line from base of the patch range. False by -// default. -// -// - GerritNav.View.GROUP: -// - `groupId`, required, String: the ID of the group. -// - `detail`, optional, String: the name of the group detail view. -// Takes any value from GerritNav.GroupDetailView. -// -// - GerritNav.View.REPO: -// - `repoName`, required, String: the name of the repo -// - `detail`, optional, String: the name of the repo detail view. -// Takes any value from GerritNav.RepoDetailView. -// -// - GerritNav.View.DASHBOARD -// - `repo`, optional, String. -// - `sections`, optional, Array of objects with `title` and `query` -// strings. -// - `user`, optional, String. -// -// - GerritNav.View.ROOT: -// - no possible parameters. +// GenerateUrlParameters lists all the possible view parameters. const uninitialized = () => { console.warn('Use of uninitialized routing');