Inheritance: DocBase
Exemplo n.º 1
0
        public string BuildTypeDoc(TypeDoc typeDoc, bool isFirstTypeDoc)
        {
            _markupStringBuilder.Clear();

            if(!isFirstTypeDoc || _forceHeaderRendering)
                RenderTypeName(typeDoc.Name);
            else
                if(_renderSampleSiteLink)
                RenderSampleSiteLink(typeDoc.Name);

            if(!String.IsNullOrWhiteSpace(typeDoc.BaseTypeName))
                RenderBaseTypeReference(typeDoc.BaseTypeName);

            RenderTypeDescription(typeDoc.Summary);
            RenderTypeRemarks(typeDoc.Remarks);

            RenderProperties(typeDoc.Properties.OrderBy(p => p.Name));
            RenderMethods(typeDoc.Methods.OrderBy(m => m.Name), "Methods");
            RenderEvents(typeDoc.Events.OrderBy(e => e.Name));

            RenderClientProperties(typeDoc.ClientProperties.OrderBy(p => p.Name));
            RenderMethods(typeDoc.ClientMethods.OrderBy(m => m.Name), "Client methods");
            RenderClientEvents(typeDoc.ClientEvents.OrderBy(e => e.Name));

            RenderClientPropertiesExpanded(typeDoc.ClientProperties.OrderBy(p => p.Name));
            RenderMethodsExpanded(typeDoc.Methods.OrderBy(m => m.Name), "Methods");
            RenderMethodsExpanded(typeDoc.ClientMethods.OrderBy(m => m.Name), "Client methods");
            RenderClientEventsExpanded(typeDoc.ClientEvents.OrderBy(e => e.Name));

            return _markupStringBuilder.ToString();
        }
Exemplo n.º 2
0
        string BuildAnimationScriptsTree(TypeDoc typeDoc, IEnumerable <TypeDoc> animationTypeDocs)
        {
            _markupStringBuilder.Clear();

            foreach (var animationTypeDoc in animationTypeDocs)
            {
                var baseTypeShortName = RemoveRootNamespace(animationTypeDoc.BaseTypeName);
                var typeLevel         = GetTypeLevel(baseTypeShortName, animationTypeDocs);
                _markupStringBuilder.Append(
                    _renderer.RenderListItem(
                        animationTypeDoc.Name != typeDoc?.Name
                            ? _renderer.RenderWikiPageLink(animationTypeDoc.Name)
                            : animationTypeDoc.Name,
                        false,
                        typeLevel));
            }

            return(_markupStringBuilder.ToString());
        }
Exemplo n.º 3
0
        public string BuildTypeDoc(TypeDoc typeDoc)
        {
            _docStringBuilder.Clear();

            RenderTypeName(typeDoc.Name);
            RenderSampleSiteLink(typeDoc.Name);
            RenderTypeDescription(typeDoc.Summary);
            RenderTypeRemarks(typeDoc.Remarks);

            RenderProperties(typeDoc.Properties.OrderBy(p => p.Name));
            RenderMethods(typeDoc.Methods.OrderBy(m => m.Name), "Methods");
            RenderEvents(typeDoc.Events.OrderBy(e => e.Name));

            RenderClientProperties(typeDoc.ClientProperties.OrderBy(p => p.Name));
            RenderMethods(typeDoc.ClientMethods.OrderBy(m => m.Name), "Client methods");
            RenderClientEvents(typeDoc.ClientEvents.OrderBy(p => p.Name));

            return(_docStringBuilder.ToString());
        }
Exemplo n.º 4
0
        public string BuildTypeDoc(TypeDoc typeDoc, bool isFirstTypeDoc)
        {
            _markupStringBuilder.Clear();

            if (!isFirstTypeDoc || _forceHeaderRendering)
            {
                RenderTypeName(typeDoc.Name);
            }
            else
            if (_renderSampleSiteLink)
            {
                RenderSampleSiteLink(typeDoc.Name);
            }

            if (!String.IsNullOrWhiteSpace(typeDoc.BaseTypeName))
            {
                RenderBaseTypeReference(typeDoc.BaseTypeName);
            }

            RenderTypeDescription(typeDoc.Summary);
            RenderTypeRemarks(typeDoc.Remarks);

            RenderProperties(typeDoc.Properties.OrderBy(p => p.Name));
            RenderMethods(typeDoc.Methods.OrderBy(m => m.Name), "Methods");
            RenderEvents(typeDoc.Events.OrderBy(e => e.Name));

            RenderClientProperties(typeDoc.ClientProperties.OrderBy(p => p.Name));
            RenderMethods(typeDoc.ClientMethods.OrderBy(m => m.Name), "Client methods");
            RenderClientEvents(typeDoc.ClientEvents.OrderBy(e => e.Name));

            RenderClientPropertiesExpanded(typeDoc.ClientProperties.OrderBy(p => p.Name));
            RenderMethodsExpanded(typeDoc.Methods.OrderBy(m => m.Name), "Methods");
            RenderMethodsExpanded(typeDoc.ClientMethods.OrderBy(m => m.Name), "Client methods");
            RenderClientEventsExpanded(typeDoc.ClientEvents.OrderBy(e => e.Name));

            return(_markupStringBuilder.ToString());
        }
Exemplo n.º 5
0
        public string BuildTypeDoc(TypeDoc typeDoc)
        {
            _markupStringBuilder.Clear();

            RenderTypeName(typeDoc.Name);
            RenderSampleSiteLink(typeDoc.Name);
            RenderTypeDescription(typeDoc.Summary);
            RenderTypeRemarks(typeDoc.Remarks);

            RenderProperties(typeDoc.Properties);
            RenderMethods(typeDoc.Methods, "Methods");
            RenderEvents(typeDoc.Events);

            RenderClientProperties(typeDoc.ClientProperties);
            RenderMethods(typeDoc.ClientMethods, "Client methods");
            RenderClientEvents(typeDoc.ClientEvents);

            RenderClientPropertiesExpanded(typeDoc.ClientProperties);
            RenderMethodsExpanded(typeDoc.Methods, "Methods");
            RenderMethodsExpanded(typeDoc.ClientMethods, "Client methods");
            RenderClientEventsExpanded(typeDoc.ClientEvents);

            return(_markupStringBuilder.ToString());
        }
Exemplo n.º 6
0
        public string BuildTypeDoc(TypeDoc typeDoc)
        {
            _markupStringBuilder.Clear();

            RenderTypeName(typeDoc.Name);
            RenderSampleSiteLink(typeDoc.Name);
            RenderTypeDescription(typeDoc.Summary);
            RenderTypeRemarks(typeDoc.Remarks);

            RenderProperties(typeDoc.Properties);
            RenderMethods(typeDoc.Methods, "Methods");
            RenderEvents(typeDoc.Events);

            RenderClientProperties(typeDoc.ClientProperties);
            RenderMethods(typeDoc.ClientMethods, "Client methods");
            RenderClientEvents(typeDoc.ClientEvents);

            RenderClientPropertiesExpanded(typeDoc.ClientProperties);
            RenderMethodsExpanded(typeDoc.Methods, "Methods");
            RenderMethodsExpanded(typeDoc.ClientMethods, "Client methods");
            RenderClientEventsExpanded(typeDoc.ClientEvents);

            return _markupStringBuilder.ToString();
        }
Exemplo n.º 7
0
        string BuildAnimationScriptsTree(TypeDoc typeDoc, IEnumerable<TypeDoc> animationTypeDocs)
        {
            _markupStringBuilder.Clear();

            foreach(var animationTypeDoc in animationTypeDocs) {
                var baseTypeShortName = RemoveRootNamespace(animationTypeDoc.BaseTypeName);
                var typeLevel = GetTypeLevel(baseTypeShortName, animationTypeDocs);
                _markupStringBuilder.Append(
                    _renderer.RenderListItem(
                        animationTypeDoc.Name != typeDoc?.Name
                            ? _renderer.RenderWikiPageLink(animationTypeDoc.Name)
                            : animationTypeDoc.Name,
                        false,
                        typeLevel));
            }

            return _markupStringBuilder.ToString();
        }