Python description Examples

Example #1

def generate_file_doc(compound):

    doxylayout.header()

    doxylayout.navheader()

    doxylayout.begin_content()

    def title():
        DocState.writer.element("span", compound.kind.title(), {"class": "compound-kind"})
        DocState.writer.element("span", " " + compound.name)

    doxylayout.pagetitle(title)

    if DocSettings.show_file_paths:
        doxylayout.file_path(compound.location)

    doxylayout.description(compound.briefdescription)
    doxylayout.description(compound.detaileddescription)

    if len(compound.innerclasses) > 0:
        doxylayout.file_list_inner_classes(compound.innerclasses)

    if len(compound.innernamespaces) > 0:
        doxylayout.file_list_inner_namespaces(compound.innernamespaces)

    doxytiny.programlisting(compound.contents)
    doxylayout.end_content()
    doxylayout.footer()

Example #2

def generate_index():

	f = file(filename, "w")

	for obj in DocState.iter_unique_docobjs():
		try:
			id = obj.full_url()
			name = obj.name
			desc = ""
			compound = ""
			kind = ""
			if hasattr(obj, "briefdescription"):
				DocState.pushwriterplain()
				doxylayout.description(obj.briefdescription)
				desc = DocState.popwriter()

			if hasattr(obj, "compound") and obj.compound is not None:
				compound = obj.compound.name

			if hasattr(obj, "kind") and obj.kind is not None:
				kind = obj.kind

			f.write(id + delimiter + name + delimiter + desc + delimiter + compound + delimiter + kind + rowdelimiter)
		except:
			print(vars(obj))
			raise

	f.close()

Example #3

def generate_page_doc(compound):

    doxylayout.header()

    doxylayout.navheader()

    doxylayout.begin_content()

    doxylayout.pagetitle(compound.name)

    doxylayout.description(compound.briefdescription)
    doxylayout.description(compound.detaileddescription)

    doxylayout.end_content()
    doxylayout.footer()

Example #4

def generate_example_doc(compound):

    doxylayout.header()

    doxylayout.navheader()

    doxylayout.begin_content()

    def title():
        DocState.writer.element("span", compound.kind.title(), {"class": "compound-kind"})
        DocState.writer.element("span", " " + compound.name)

    doxylayout.pagetitle(title)

    doxylayout.description(compound.briefdescription)
    doxylayout.description(compound.detaileddescription)

    doxylayout.end_content()
    doxylayout.footer()

Example #5

def generate_group_doc(compound):
    
    doxylayout.header()

    doxylayout.navheader()

    doxylayout.begin_content()

    def title():
        DocState.writer.element("span", compound.kind.title(), {"class": "compound-kind"})
        DocState.writer.element("span", " " + compound.title)

    doxylayout.pagetitle(title)

    doxylayout.description(compound.briefdescription)
    doxylayout.description(compound.detaileddescription)

    doxylayout.group_list_inner_groups(compound.innergroups)
    doxylayout.group_list_inner_classes(compound.innerclasses)
    doxylayout.group_list_inner_namespaces(compound.innernamespaces)

    doxylayout.end_content()
    doxylayout.footer()