Examples of org.openquark.cal.compiler.CALDocComment

org.openquark.cal.compiler.CALDocComment
The representation of a CALDoc comment as stored by ModuleTypeInfo objects. A CALDoc comment consists of a description block followed by a list of tagged blocks.
This class is intended to be constructible only by other classes within this package. Clients should not be able to create instances of this class. Therefore, the compiler can guarantee that a CALDocComment object represents a syntactically and semantically correct CALDoc comment.
This class is intended to be immutable, so that objects of this class can be safely returned to clients without worrying about the possibility of these objects being modified. @author Joseph Wong

     */
    @Override
    void generateModuleDescription(ModuleTypeInfo moduleTypeInfo) {
        ModuleName moduleName = moduleTypeInfo.getModuleName();
        CALFeatureMetadata metadata = getMetadata(CALFeatureName.getModuleFeatureName(moduleName), getLocale());
        CALDocComment docComment = moduleTypeInfo.getCALDocComment();


        /// For a module, just generate its description and supplementary blocks
        //
        generateStandardDescription(metadata, docComment, inModulesSubdirectoryReferenceGenerator);
        generateStandardSupplementaryBlocks(metadata, docComment, inModulesSubdirectoryReferenceGenerator);

View Full Code Here

        // populated and ready to serve out disambiguated names.
        //
        addTypeConsNameToDisambiguationMap(typeConstructor.getName().getModuleName(), typeConstructor.getName().getUnqualifiedName());
        
        CALFeatureMetadata metadata = getMetadata(CALFeatureName.getTypeConstructorFeatureName(typeConstructor.getName()), getLocale());
        CALDocComment docComment = typeConstructor.getCALDocComment();
        
        /// Generate the scope and name of the type constructor
        //
        currentPage
            .openTag(HTML.Tag.TR, classAttribute(getScopeStyleClass(typeConstructor.getScope())))

View Full Code Here

     * {@inheritDoc}
     */
    @Override
    void generateDataConsOverview(DataConstructor dataConstructor) {
        FunctionalAgentMetadata metadata = (FunctionalAgentMetadata)getMetadata(CALFeatureName.getDataConstructorFeatureName(dataConstructor.getName()), getLocale());
        CALDocComment docComment = dataConstructor.getCALDocComment();
        
        // We delegate the generation to the helper that handles all function agents
        generateFunctionalAgentOverview(dataConstructor, labelMaker.getLabel(dataConstructor), metadata, docComment, StyleClassConstants.OVERVIEW_TABLE_NESTED_DESCRIPTION);
    }

View Full Code Here

     * {@inheritDoc}
     */
    @Override
    void generateFunctionOverview(Function function) {
        FunctionalAgentMetadata metadata = (FunctionalAgentMetadata)getMetadata(CALFeatureName.getFunctionFeatureName(function.getName()), getLocale());
        CALDocComment docComment = function.getCALDocComment();
        
        // We delegate the generation to the helper that handles all function agents
        generateFunctionalAgentOverview(function, labelMaker.getLabel(function), metadata, docComment, StyleClassConstants.OVERVIEW_TABLE_OUTER_DESCRIPTION);
    }

View Full Code Here

        // populated and ready to serve out disambiguated names.
        //
        addTypeClassNameToDisambiguationMap(typeClass.getName().getModuleName(), typeClass.getName().getUnqualifiedName());
        
        CALFeatureMetadata metadata = getMetadata(CALFeatureName.getTypeClassFeatureName(typeClass.getName()), getLocale());
        CALDocComment docComment = typeClass.getCALDocComment();
        
        /// Generate the scope and name of the type class
        //
        currentPage
            .openTag(HTML.Tag.TR, classAttribute(getScopeStyleClass(typeClass.getScope())))

View Full Code Here

     * {@inheritDoc}
     */
    @Override
    void generateClassMethodOverview(ClassMethod classMethod) {
        FunctionalAgentMetadata metadata = (FunctionalAgentMetadata)getMetadata(CALFeatureName.getClassMethodFeatureName(classMethod.getName()), getLocale());
        CALDocComment docComment = classMethod.getCALDocComment();
        
        // We delegate the generation to the helper that handles all function agents
        generateFunctionalAgentOverview(classMethod, labelMaker.getLabel(classMethod), metadata, docComment, StyleClassConstants.OVERVIEW_TABLE_NESTED_DESCRIPTION);
    }

View Full Code Here

     * {@inheritDoc}
     */
    @Override
    void generateClassInstanceOverviewHeader(ClassInstance classInstance) {
        CALFeatureMetadata metadata = getMetadata(CALFeatureName.getClassInstanceFeatureName(classInstance), getLocale());
        CALDocComment docComment = classInstance.getCALDocComment();


        /// Generate the name of the class instance
        //
        currentPage
            .openTag(HTML.Tag.TR, classAttribute(getScopeStyleClass(minScopeForInstanceClassAndInstanceType(classInstance))))

View Full Code Here

     * {@inheritDoc}
     */
    @Override
    void generateTypeConsDocHeader(TypeConstructor typeConstructor, int index) {
        CALFeatureMetadata metadata = getMetadata(CALFeatureName.getTypeConstructorFeatureName(typeConstructor.getName()), getLocale());
        CALDocComment docComment = typeConstructor.getCALDocComment();


        /// Generate the name of the type constructor as the header, followed by a link to the usages if necessary
        //
        String unqualifiedName = typeConstructor.getName().getUnqualifiedName();

View Full Code Here

     * {@inheritDoc}
     */
    @Override
    void generateDataConsDoc(DataConstructor dataConstructor, int index) {
        FunctionalAgentMetadata metadata = (FunctionalAgentMetadata)getMetadata(CALFeatureName.getDataConstructorFeatureName(dataConstructor.getName()), getLocale());
        CALDocComment docComment = dataConstructor.getCALDocComment();


        // We delegate the generation to the helper that handles all function agents
        generateFunctionalAgentDoc(dataConstructor, labelMaker.getLabel(dataConstructor), metadata, docComment, index, false);
    }

View Full Code Here

     * {@inheritDoc}
     */
    @Override
    void generateFunctionDoc(Function function, int index) {
        FunctionalAgentMetadata metadata = (FunctionalAgentMetadata)getMetadata(CALFeatureName.getFunctionFeatureName(function.getName()), getLocale());
        CALDocComment docComment = function.getCALDocComment();
        
        // We delegate the generation to the helper that handles all function agents.
        // The helper expects to work in the context of a definition list, so we create one.
        currentPage.openTag(HTML.Tag.DL, classAttribute(getScopeStyleClass(function.getScope())));
        generateFunctionalAgentDoc(function, labelMaker.getLabel(function), metadata, docComment, index, true);

View Full Code Here

0 1 2 3 4

TOP

Related Classes of org.openquark.cal.compiler.CALDocComment

org.openquark.cal.caldoc.CALDocToTextUtilities

org.openquark.cal.caldoc.CALDocToTooltipHTMLUtilities

org.openquark.cal.caldoc.HTMLDocumentationGenerator

org.openquark.cal.ICE

org.openquark.cal.internal.javamodel.JavaBindingGenerator

org.openquark.cal.internal.serialization.RecordInputStream.RecordHeaderInfo

org.openquark.cal.UncheckedCALDocReferencesValidity_Test

org.openquark.gems.client.FunctionalAgentGem

org.openquark.gems.client.navigator.NavHtmlFactory

org.openquark.gems.client.ToolTipHelpers

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.