Skip to content
Snippets Groups Projects
Commit be7130cb authored by Dumoulin Cédric's avatar Dumoulin Cédric
Browse files

ecoredoc: Generate package doc.

Doagram is not generated yet.
parent 759047c6
No related branches found
No related tags found
No related merge requests found
[comment encoding = UTF-8 /]
[**
* Generate Dev doc for Classifiers.
*/]
[module generateDevPackageDocFile('http://www.eclipse.org/emf/2002/Ecore', 'http://www.eclipse.org/emf/2002/GenModel')]
[import cdm::ecoredoc::generator::common::requests::namingQueries /]
[import cdm::ecoredoc::generator::ecore::requests::EPackageQueries /]
[import cdm::ecoredoc::generator::ecore::requests::EClassQueries /]
[import cdm::ecoredoc::generator::docgen::requests::UrlQueries /]
[import cdm::ecoredoc::generator::docgen::common::generateClassDiagram /]
[import cdm::ecoredoc::generator::docgen::common::generateEClassifier /]
[comment import cdm::ecoredoc::generator::ecore::services::EcoreToMdDocUtils /]
[import cdm::ecoredoc::generator::docgen::requests::DocumentationAnnotationQueries /]
[query protected GenModelAnnotationSourceName(any : OclAny) : String = 'http://www.eclipse.org/emf/2002/GenModel' /]
[**
* The documentation of the template generateElement.
* @param aGenPackage
*/]
[template public generateDevPackageDocFile(ele : EPackage)
{
packageFullDocFileName : String = ele.getEPackageDocFileFullPathname();
classname : String = ele.name;
}
]
[file ( packageFullDocFileName, false, 'UTF-8')]
import DocCardList from '@theme/DocCardList';
# [classname/]
[ele.generateDocumentationSection() /]
[ele.generateClassDiagramSection() /]
[/file]
[/template]
[**
*
*/]
[template protected generateDocumentationSection(ele : EModelElement)
{
doc : String = ele.getDevFullDocumentation().orElse('No Documentation.');
}
]
[doc/]
<DocCardList />
[/template]
[**
* Generate the Class diagram section
*/]
[template protected generateClassDiagramSection(ele : EPackage)]
## Package Diagram
TO BE DONE
[comment ele.generateClassDiagram()/]
[/template]
...@@ -3,9 +3,9 @@ ...@@ -3,9 +3,9 @@
[module EPackageQueries('http://www.eclipse.org/emf/2002/Ecore', 'http://www.eclipse.org/emf/2002/GenModel')] [module EPackageQueries('http://www.eclipse.org/emf/2002/Ecore', 'http://www.eclipse.org/emf/2002/GenModel')]
[import cdm::ecoredoc::generator::common::requests::namingQueries /]
[** [**
* Get EClassifier full package name, '.' separated * Get EPackage full package name, '.' separated
*/] */]
[query public getEPackageFullName(epackage : EPackage) : String = [query public getEPackageFullName(epackage : EPackage) : String =
if( epackage.eSuperPackage.oclIsUndefined() ) if( epackage.eSuperPackage.oclIsUndefined() )
...@@ -13,3 +13,22 @@ if( epackage.eSuperPackage.oclIsUndefined() ) ...@@ -13,3 +13,22 @@ if( epackage.eSuperPackage.oclIsUndefined() )
else epackage.eSuperPackage.getEPackageFullName() + '.' + epackage.name else epackage.eSuperPackage.getEPackageFullName() + '.' + epackage.name
endif endif
/] /]
[**
* Get EPackage full path name, '/' separated
*/]
[query public getEPackageFullPath(eclass : EPackage) : String =
eclass.getEPackageFullName().toPathname()
/]
[**
* Get the full path name of this package doc file.
*
* The name end with '.md'
* The docfile for a package is a file with the same name as the package, located inside the package.
*
*/]
[query public getEPackageDocFileFullPathname(eclass : EPackage) : String =
eclass.getEPackageFullPath() + '/' + eclass.name + '.md'
/]
...@@ -7,6 +7,7 @@ ...@@ -7,6 +7,7 @@
[import cdm::ecoredoc::generator::devdocgen::files::generateDevClassifierDocFile /] [import cdm::ecoredoc::generator::devdocgen::files::generateDevClassifierDocFile /]
[import cdm::ecoredoc::generator::devdocgen::files::generateDevEnumDocFile /] [import cdm::ecoredoc::generator::devdocgen::files::generateDevEnumDocFile /]
[import cdm::ecoredoc::generator::devdocgen::files::generateDevPackageDocFile /]
[** [**
* The documentation of the template generateElement. * The documentation of the template generateElement.
...@@ -20,6 +21,10 @@ ...@@ -20,6 +21,10 @@
} }
] ]
[comment @main/] [comment @main/]
[comment package doc/]
[folder.generateDevPackageDocFile()/]
[comment Classifiers /] [comment Classifiers /]
[for (ele : EClass | classes)] [for (ele : EClass | classes)]
[ele.generateDevClassifierDocFile()/] [ele.generateDevClassifierDocFile()/]
......
...@@ -7,6 +7,8 @@ ...@@ -7,6 +7,8 @@
[import cdm::ecoredoc::generator::userdocgen::files::generateUserClassifierDocFile /] [import cdm::ecoredoc::generator::userdocgen::files::generateUserClassifierDocFile /]
[import cdm::ecoredoc::generator::userdocgen::files::generateUserEnumDocFile /] [import cdm::ecoredoc::generator::userdocgen::files::generateUserEnumDocFile /]
[import cdm::ecoredoc::generator::userdocgen::files::generateUserPackageDocFile /]
[** [**
* The documentation of the template generateElement. * The documentation of the template generateElement.
* @param aGenPackage * @param aGenPackage
...@@ -19,6 +21,10 @@ ...@@ -19,6 +21,10 @@
} }
] ]
[comment @main/] [comment @main/]
[comment package doc /]
[folder.generateUserPackageDocFile()/]
[comment Classifiers /] [comment Classifiers /]
[for (ele : EClass | classes)] [for (ele : EClass | classes)]
[ele.generateUserClassifierDocFile()/] [ele.generateUserClassifierDocFile()/]
......
[comment encoding = UTF-8 /]
[**
* Generate User doc for Classifiers.
*/]
[module generateUserPackageDocFile('http://www.eclipse.org/emf/2002/Ecore', 'http://www.eclipse.org/emf/2002/GenModel')]
[import cdm::ecoredoc::generator::common::requests::namingQueries /]
[import cdm::ecoredoc::generator::ecore::requests::EPackageQueries /]
[import cdm::ecoredoc::generator::ecore::requests::EClassQueries /]
[import cdm::ecoredoc::generator::docgen::requests::UrlQueries /]
[import cdm::ecoredoc::generator::docgen::common::generateClassDiagram /]
[import cdm::ecoredoc::generator::docgen::common::generateEClassifier /]
[comment import cdm::ecoredoc::generator::ecore::services::EcoreToMdDocUtils /]
[import cdm::ecoredoc::generator::docgen::requests::DocumentationAnnotationQueries /]
[query protected GenModelAnnotationSourceName(any : OclAny) : String = 'http://www.eclipse.org/emf/2002/GenModel' /]
[**
* The documentation of the template generateElement.
* @param aGenPackage
*/]
[template public generateUserPackageDocFile(ele : EPackage)
{
packageFullDocFileName : String = ele.getEPackageDocFileFullPathname();
classname : String = ele.name;
}
]
[file ( packageFullDocFileName, false, 'UTF-8')]
import DocCardList from '@theme/DocCardList';
# [classname/]
[ele.generateDocumentationSection() /]
[ele.generateClassDiagramSection() /]
[/file]
[/template]
[**
*
*/]
[template protected generateDocumentationSection(ele : EModelElement)
{
doc : String = ele.getUserFullDocumentation().orElse('No Documentation.');
}
]
[doc/]
<DocCardList />
[/template]
[**
* Generate the Class diagram section
*/]
[template protected generateClassDiagramSection(ele : EPackage)]
## Package Diagram
TO BE DONE
[comment ele.generateClassDiagram()/]
[/template]
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment