Update and fix compodoc generation
Fixes and updates compodoc.
This commit is contained in:
parent
adcf98a69b
commit
677a93e2ca
10
client/.compodocrc.json
Normal file
10
client/.compodocrc.json
Normal file
@ -0,0 +1,10 @@
|
||||
{
|
||||
"name": "OpenSlides Client Documentation",
|
||||
"output": "../Compodoc/",
|
||||
"tsconfig": "./tsconfig.json",
|
||||
"disableCoverage": true,
|
||||
"hideGenerator": true,
|
||||
"theme": "material",
|
||||
"customLogo": "./src/assets/img/openslides-logo.svg",
|
||||
"customFavicon": "./src/assets/img/favicon.png"
|
||||
}
|
@ -23,7 +23,8 @@
|
||||
"lint-write": "ng lint --fix",
|
||||
"e2e": "ng e2e",
|
||||
"licenses": "node src/crawler.js",
|
||||
"compodoc": "./node_modules/.bin/compodoc --hideGenerator -p tsconfig.app.json -n 'OpenSlides Documentation' -d ../Compodoc -s -o -r",
|
||||
"doc-serve": "./node_modules/.bin/compodoc -c .compodocrc.json -s -o -r",
|
||||
"doc-build": "./node_modules/.bin/compodoc -c .compodocrc.json",
|
||||
"extract": "ngx-translate-extract -i ./src -o ./src/assets/i18n/template-en.pot --clean --sort --format pot",
|
||||
"po2json": "./node_modules/.bin/po2json -f mf src/assets/i18n/de.po src/assets/i18n/de.json && ./node_modules/.bin/po2json -f mf src/assets/i18n/cs.po src/assets/i18n/cs.json && ./node_modules/.bin/po2json -f mf src/assets/i18n/ru.po src/assets/i18n/ru.json",
|
||||
"po2json-tempfix": "./node_modules/.bin/po2json -f mf src/assets/i18n/de.po /dev/stdout | sed -f sed_replacements > src/assets/i18n/de.json && ./node_modules/.bin/po2json -f mf src/assets/i18n/cs.po /dev/stdout | sed -f sed_replacements > src/assets/i18n/cs.json && ./node_modules/.bin/po2json -f mf src/assets/i18n/ru.po /dev/stdout | sed -f sed_replacements > src/assets/i18n/ru.json",
|
||||
@ -87,7 +88,7 @@
|
||||
"@angular/language-service": "~10.0.14",
|
||||
"@biesbjerg/ngx-translate-extract": "^7.0.2",
|
||||
"@biesbjerg/ngx-translate-extract-marker": "^1.0.0",
|
||||
"@compodoc/compodoc": "^1.1.8",
|
||||
"@compodoc/compodoc": "^1.1.11",
|
||||
"@schematics/angular": "^10.0.8",
|
||||
"@types/jasmine": "^3.5.14",
|
||||
"@types/jasminewd2": "^2.0.6",
|
||||
|
@ -1,5 +1,5 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { LoginLegalNoticeComponent } from './site/login/components/login-legal-notice/login-legal-notice.component';
|
||||
import { LoginMaskComponent } from './site/login/components/login-mask/login-mask.component';
|
||||
@ -12,7 +12,7 @@ import { UnsupportedBrowserComponent } from './site/login/components/unsupported
|
||||
/**
|
||||
* Global app routing
|
||||
*/
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{
|
||||
path: 'login',
|
||||
component: LoginWrapperComponent,
|
||||
|
@ -1,9 +1,9 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { FullscreenProjectorComponent } from './fullscreen-projector/fullscreen-projector.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{
|
||||
path: '',
|
||||
component: FullscreenProjectorComponent,
|
||||
|
@ -1,5 +1,5 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { AgendaListComponent } from './components/agenda-list/agenda-list.component';
|
||||
import { AgendaSortComponent } from './components/agenda-sort/agenda-sort.component';
|
||||
@ -8,7 +8,7 @@ import { WatchForChangesGuard } from 'app/shared/utils/watch-for-changes.guard';
|
||||
import { TopicImportListComponent } from 'app/site/topics/components/topic-import-list/topic-import-list.component';
|
||||
import { ListOfSpeakersComponent } from './components/list-of-speakers/list-of-speakers.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{ path: '', component: AgendaListComponent, pathMatch: 'full' },
|
||||
{ path: 'import', component: TopicImportListComponent, data: { basePerm: Permission.agendaCanManage } },
|
||||
{
|
||||
|
@ -1,11 +1,11 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { Permission } from 'app/core/core-services/operator.service';
|
||||
import { AssignmentDetailComponent } from './components/assignment-detail/assignment-detail.component';
|
||||
import { AssignmentListComponent } from './components/assignment-list/assignment-list.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{ path: '', component: AssignmentListComponent, pathMatch: 'full' },
|
||||
{ path: 'new', component: AssignmentDetailComponent, data: { basePerm: Permission.assignmentsCanManage } },
|
||||
{ path: ':id', component: AssignmentDetailComponent, data: { basePerm: Permission.assignmentsCanSee } },
|
||||
|
@ -1,9 +1,9 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { AssignmentPollDetailComponent } from './components/assignment-poll-detail/assignment-poll-detail.component';
|
||||
|
||||
const routes: Routes = [{ path: ':id', component: AssignmentPollDetailComponent }];
|
||||
const routes: Route[] = [{ path: ':id', component: AssignmentPollDetailComponent }];
|
||||
|
||||
@NgModule({
|
||||
imports: [RouterModule.forChild(routes)],
|
||||
|
@ -1,9 +1,9 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { CinemaComponent } from './components/cinema/cinema.component';
|
||||
|
||||
const routes: Routes = [{ path: '', component: CinemaComponent, pathMatch: 'full' }];
|
||||
const routes: Route[] = [{ path: '', component: CinemaComponent, pathMatch: 'full' }];
|
||||
|
||||
@NgModule({
|
||||
imports: [RouterModule.forChild(routes)],
|
||||
|
@ -1,5 +1,5 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { Permission } from 'app/core/core-services/operator.service';
|
||||
import { ErrorComponent } from './components/error/error.component';
|
||||
@ -7,7 +7,7 @@ import { LegalNoticeComponent } from './components/legal-notice/legal-notice.com
|
||||
import { PrivacyPolicyComponent } from './components/privacy-policy/privacy-policy.component';
|
||||
import { StartComponent } from './components/start/start.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{
|
||||
path: '',
|
||||
component: StartComponent,
|
||||
|
@ -1,11 +1,11 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { WatchForChangesGuard } from 'app/shared/utils/watch-for-changes.guard';
|
||||
import { ConfigListComponent } from './components/config-list/config-list.component';
|
||||
import { ConfigOverviewComponent } from './components/config-overview/config-overview.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{ path: '', component: ConfigOverviewComponent, pathMatch: 'full' },
|
||||
{ path: ':group', component: ConfigListComponent, canDeactivate: [WatchForChangesGuard] }
|
||||
];
|
||||
|
@ -1,12 +1,12 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { HistoryListComponent } from './components/history-list/history-list.component';
|
||||
|
||||
/**
|
||||
* Define the routes for the history module
|
||||
*/
|
||||
const routes: Routes = [{ path: '', component: HistoryListComponent, pathMatch: 'full' }];
|
||||
const routes: Route[] = [{ path: '', component: HistoryListComponent, pathMatch: 'full' }];
|
||||
|
||||
/**
|
||||
* Define the routing component and setup the routes
|
||||
|
@ -1,11 +1,11 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { Permission } from 'app/core/core-services/operator.service';
|
||||
import { MediaUploadComponent } from './components/media-upload/media-upload.component';
|
||||
import { MediafileListComponent } from './components/mediafile-list/mediafile-list.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{
|
||||
path: '',
|
||||
redirectTo: 'files',
|
||||
|
@ -1,9 +1,9 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { AmendmentListComponent } from './amendment-list.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{
|
||||
path: '',
|
||||
component: AmendmentListComponent,
|
||||
|
@ -1,10 +1,10 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { WatchForChangesGuard } from 'app/shared/utils/watch-for-changes.guard';
|
||||
import { CallListComponent } from './call-list.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{ path: '', component: CallListComponent, pathMatch: 'full', canDeactivate: [WatchForChangesGuard] }
|
||||
];
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { WatchForChangesGuard } from 'app/shared/utils/watch-for-changes.guard';
|
||||
import { CategoriesSortComponent } from './components/categories-sort/categories-sort.component';
|
||||
@ -7,7 +7,7 @@ import { CategoryDetailComponent } from './components/category-detail/category-d
|
||||
import { CategoryListComponent } from './components/category-list/category-list.component';
|
||||
import { CategoryMotionsSortComponent } from './components/category-motions-sort/category-motions-sort.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{ path: '', component: CategoryListComponent, pathMatch: 'full' },
|
||||
{ path: ':id/sort', component: CategoryMotionsSortComponent, canDeactivate: [WatchForChangesGuard] },
|
||||
{ path: 'sort', component: CategoriesSortComponent, canDeactivate: [WatchForChangesGuard] },
|
||||
|
@ -1,10 +1,10 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { MotionBlockDetailComponent } from './components/motion-block-detail/motion-block-detail.component';
|
||||
import { MotionBlockListComponent } from './components/motion-block-list/motion-block-list.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{ path: '', component: MotionBlockListComponent, pathMatch: 'full' },
|
||||
{ path: ':id', component: MotionBlockDetailComponent }
|
||||
];
|
||||
|
@ -1,10 +1,10 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { MotionCommentSectionListComponent } from './components/motion-comment-section-list/motion-comment-section-list.component';
|
||||
import { MotionCommentSectionSortComponent } from './components/motion-comment-section-sort/motion-comment-section-sort.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{ path: '', component: MotionCommentSectionListComponent, pathMatch: 'full' },
|
||||
{ path: 'sort', component: MotionCommentSectionSortComponent }
|
||||
];
|
||||
|
@ -1,10 +1,10 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { AmendmentCreateWizardComponent } from './components/amendment-create-wizard/amendment-create-wizard.component';
|
||||
import { MotionDetailComponent } from './components/motion-detail/motion-detail.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{ path: '', component: MotionDetailComponent, pathMatch: 'full', runGuardsAndResolvers: 'paramsChange' },
|
||||
{ path: 'create-amendment', component: AmendmentCreateWizardComponent }
|
||||
];
|
||||
|
@ -1,9 +1,9 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { MotionImportListComponent } from './motion-import-list.component';
|
||||
|
||||
const routes: Routes = [{ path: '', component: MotionImportListComponent, pathMatch: 'full' }];
|
||||
const routes: Route[] = [{ path: '', component: MotionImportListComponent, pathMatch: 'full' }];
|
||||
|
||||
@NgModule({
|
||||
imports: [RouterModule.forChild(routes)],
|
||||
|
@ -1,9 +1,9 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { MotionListComponent } from './components/motion-list/motion-list.component';
|
||||
|
||||
const routes: Routes = [{ path: '', component: MotionListComponent, pathMatch: 'full' }];
|
||||
const routes: Route[] = [{ path: '', component: MotionListComponent, pathMatch: 'full' }];
|
||||
@NgModule({
|
||||
imports: [RouterModule.forChild(routes)],
|
||||
exports: [RouterModule]
|
||||
|
@ -1,9 +1,9 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { MotionPollDetailComponent } from './motion-poll-detail/motion-poll-detail.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{ path: 'new', component: MotionPollDetailComponent },
|
||||
{ path: ':id', component: MotionPollDetailComponent }
|
||||
];
|
||||
|
@ -1,10 +1,10 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { WorkflowDetailComponent } from './components/workflow-detail/workflow-detail.component';
|
||||
import { WorkflowListComponent } from './components/workflow-list/workflow-list.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{ path: '', component: WorkflowListComponent, pathMatch: 'full' },
|
||||
{ path: ':id', component: WorkflowDetailComponent }
|
||||
];
|
||||
|
@ -1,10 +1,10 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { StatuteImportListComponent } from './components/statute-import-list/statute-import-list.component';
|
||||
import { StatuteParagraphListComponent } from './components/statute-paragraph-list/statute-paragraph-list.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{ path: '', component: StatuteParagraphListComponent, pathMatch: 'full' },
|
||||
{ path: 'import', component: StatuteImportListComponent }
|
||||
];
|
||||
|
@ -1,9 +1,9 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { Permission } from 'app/core/core-services/operator.service';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{
|
||||
path: '',
|
||||
loadChildren: () => import('./modules/motion-list/motion-list.module').then(m => m.MotionListModule),
|
||||
|
@ -1,12 +1,12 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { PollListComponent } from './components/poll-list/poll-list.component';
|
||||
|
||||
/**
|
||||
* Define the routes for the polls module
|
||||
*/
|
||||
const routes: Routes = [{ path: '', component: PollListComponent, pathMatch: 'full' }];
|
||||
const routes: Route[] = [{ path: '', component: PollListComponent, pathMatch: 'full' }];
|
||||
|
||||
/**
|
||||
* Define the routing component and setup the routes
|
||||
|
@ -1,11 +1,11 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { Permission } from 'app/core/core-services/operator.service';
|
||||
import { ProjectorDetailComponent } from './components/projector-detail/projector-detail.component';
|
||||
import { ProjectorListComponent } from './components/projector-list/projector-list.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{
|
||||
path: '',
|
||||
component: ProjectorListComponent,
|
||||
|
@ -1,5 +1,5 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { Permission } from 'app/core/core-services/operator.service';
|
||||
import { AuthGuard } from '../core/core-services/auth-guard.service';
|
||||
@ -10,7 +10,7 @@ import { SiteComponent } from './site.component';
|
||||
*
|
||||
* TODO: Plugins will have to append to the Routes-Array
|
||||
*/
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{
|
||||
path: '',
|
||||
component: SiteComponent,
|
||||
|
@ -1,9 +1,9 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { TagListComponent } from './components/tag-list/tag-list.component';
|
||||
|
||||
const routes: Routes = [{ path: '', component: TagListComponent, pathMatch: 'full' }];
|
||||
const routes: Route[] = [{ path: '', component: TagListComponent, pathMatch: 'full' }];
|
||||
|
||||
@NgModule({
|
||||
imports: [RouterModule.forChild(routes)],
|
||||
|
@ -1,10 +1,10 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { Permission } from 'app/core/core-services/operator.service';
|
||||
import { TopicDetailComponent } from './components/topic-detail/topic-detail.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{ path: 'new', component: TopicDetailComponent, data: { basePerm: Permission.agendaCanManage } },
|
||||
{ path: ':id', component: TopicDetailComponent, data: { basePerm: Permission.agendaCanSee } }
|
||||
];
|
||||
|
@ -1,5 +1,5 @@
|
||||
import { NgModule } from '@angular/core';
|
||||
import { RouterModule, Routes } from '@angular/router';
|
||||
import { Route, RouterModule } from '@angular/router';
|
||||
|
||||
import { Permission } from 'app/core/core-services/operator.service';
|
||||
import { GroupListComponent } from './components/group-list/group-list.component';
|
||||
@ -9,7 +9,7 @@ import { UserDetailComponent } from './components/user-detail/user-detail.compon
|
||||
import { UserImportListComponent } from './components/user-import/user-import-list.component';
|
||||
import { UserListComponent } from './components/user-list/user-list.component';
|
||||
|
||||
const routes: Routes = [
|
||||
const routes: Route[] = [
|
||||
{
|
||||
path: '',
|
||||
component: UserListComponent,
|
||||
|
Loading…
Reference in New Issue
Block a user