Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/gh4 select documentation tool #35

Closed
wants to merge 1 commit into from

Conversation

TB-1993
Copy link
Contributor

@TB-1993 TB-1993 commented Apr 4, 2024

I have added samples of documentation created using doxygen, sphinx and breath for the commandModules. I figured we could use them to choose the tool we want to use. I have generated both html and markdown format using sphinx and breathe. Github pages can be configured to work with either.

Each has an index.html/index.md file in the build directory that is the starting point for the docs.

@zghp @Ulrond @barbourshop

@TB-1993 TB-1993 requested a review from Ulrond April 4, 2024 16:42
@rdkcmf-jenkins
Copy link

Copyright scan failure

Commit: 5226205
Report detail: https://gist.github.com/rdkcmf-jenkins/5ffa85a5895f2b7aef69c6317616b74d

@rdkcmf-jenkins
Copy link

Blackduck scan failure details

Summary: 0 violations, 0 files pending approval, 136 files pending identification.

  • Protex Server Path: /home/blackduck/github/python_raft/35/rdkcentral/python_raft

  • Commit: 5226205

Report detail: gist

@rdkcmf-jenkins
Copy link

Coverity detected 84 issues; a security concern.

<!-- Complex types -->

<xsd:complexType name="DoxygenType">
<xsd:sequence maxOccurs="unbounded">

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:sequence>
<xsd:element name="compoundname" type="xsd:string"/>
<xsd:element name="title" type="xsd:string" minOccurs="0" />
<xsd:element name="basecompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="compoundname" type="xsd:string"/>
<xsd:element name="title" type="xsd:string" minOccurs="0" />
<xsd:element name="basecompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="derivedcompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="title" type="xsd:string" minOccurs="0" />
<xsd:element name="basecompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="derivedcompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="includes" type="incType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="basecompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="derivedcompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="includes" type="incType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="includedby" type="incType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="includedby" type="incType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="incdepgraph" type="graphType" minOccurs="0" />
<xsd:element name="invincdepgraph" type="graphType" minOccurs="0" />
<xsd:element name="innerdir" type="refType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="incdepgraph" type="graphType" minOccurs="0" />
<xsd:element name="invincdepgraph" type="graphType" minOccurs="0" />
<xsd:element name="innerdir" type="refType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="innerfile" type="refType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="invincdepgraph" type="graphType" minOccurs="0" />
<xsd:element name="innerdir" type="refType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="innerfile" type="refType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="innerclass" type="refType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="innerdir" type="refType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="innerfile" type="refType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="innerclass" type="refType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="innernamespace" type="refType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="innerfile" type="refType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="innerclass" type="refType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="innernamespace" type="refType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="innerpage" type="refType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="innerclass" type="refType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="innernamespace" type="refType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="innerpage" type="refType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="innergroup" type="refType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="innerpage" type="refType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="innergroup" type="refType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="templateparamlist" type="templateparamlistType" minOccurs="0" />
<xsd:element name="sectiondef" type="sectiondefType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.


<xsd:complexType name="listofallmembersType">
<xsd:sequence>
<xsd:element name="member" type="memberRefType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:sequence>
<xsd:element name="header" type="xsd:string" minOccurs="0" />
<xsd:element name="description" type="descriptionType" minOccurs="0" />
<xsd:element name="memberdef" type="memberdefType" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="read" minOccurs="0" />
<xsd:element name="write" minOccurs="0" />
<xsd:element name="bitfield" minOccurs="0" />
<xsd:element name="reimplements" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="write" minOccurs="0" />
<xsd:element name="bitfield" minOccurs="0" />
<xsd:element name="reimplements" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="reimplementedby" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="bitfield" minOccurs="0" />
<xsd:element name="reimplements" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="reimplementedby" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="reimplements" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="reimplementedby" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="enumvalue" type="enumvalueType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
<xsd:element name="inbodydescription" type="descriptionType" minOccurs="0" />
<xsd:element name="location" type="locationType" />
<xsd:element name="references" type="referenceType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="inbodydescription" type="descriptionType" minOccurs="0" />
<xsd:element name="location" type="locationType" />
<xsd:element name="references" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="referencedby" type="referenceType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:complexType name="descriptionType" mixed="true">
<xsd:sequence>
<xsd:element name="title" type="xsd:string" minOccurs="0"/>
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:sequence>
<xsd:element name="title" type="xsd:string" minOccurs="0"/>
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="internal" type="docInternalType" minOccurs="0" maxOccurs="unbounded"/>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="title" type="xsd:string" minOccurs="0"/>
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="internal" type="docInternalType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.


<xsd:complexType name="templateparamlistType">
<xsd:sequence>
<xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.


<xsd:complexType name="linkedTextType" mixed="true">
<xsd:sequence>
<xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.


<xsd:complexType name="graphType">
<xsd:sequence>
<xsd:element name="node" type="nodeType" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:sequence>
<xsd:element name="label" />
<xsd:element name="link" type="linkType" minOccurs="0" />
<xsd:element name="childnode" type="childnodeType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.


<xsd:complexType name="childnodeType">
<xsd:sequence>
<xsd:element name="edgelabel" minOccurs="0" maxOccurs="unbounded"/>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.


<xsd:complexType name="listingType">
<xsd:sequence>
<xsd:element name="codeline" type="codelineType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.


<xsd:complexType name="codelineType">
<xsd:sequence>
<xsd:element name="highlight" type="highlightType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

</xsd:complexType>

<xsd:complexType name="highlightType" mixed="true">
<xsd:choice minOccurs="0" maxOccurs="unbounded">

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:complexType name="docSect1Type" mixed="true">
<xsd:sequence>
<xsd:element name="title" type="xsd:string" minOccurs="0" />
<xsd:choice maxOccurs="unbounded">

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:sequence>
<xsd:element name="title" type="xsd:string" minOccurs="0" />
<xsd:choice maxOccurs="unbounded">
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="title" type="xsd:string" minOccurs="0" />
<xsd:choice maxOccurs="unbounded">
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="internal" type="docInternalS1Type" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:choice maxOccurs="unbounded">
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="internal" type="docInternalS1Type" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="sect2" type="docSect2Type" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:complexType name="docSect2Type" mixed="true">
<xsd:sequence>
<xsd:element name="title" type="xsd:string" />
<xsd:choice maxOccurs="unbounded">

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:sequence>
<xsd:element name="title" type="xsd:string" />
<xsd:choice maxOccurs="unbounded">
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:element name="title" type="xsd:string" />
<xsd:choice maxOccurs="unbounded">
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="sect3" type="docSect3Type" minOccurs="0" maxOccurs="unbounded" />

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

<xsd:complexType name="docSect3Type" mixed="true">
<xsd:sequence>
<xsd:element name="title" type="xsd:string" />
<xsd:choice maxOccurs="unbounded">

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low impact. Security issue.
Sigma. Schema allows an unlimited number of occurrences.
The maxOccurs attribute is set to unbounded. This allows an unlimited number of occurrences for this element. Thus, attackers may take advantage of schemas that allow unbounded elements by supplying an application with a very large number elements causing the application to exhaust system resources.

@TB-1993 TB-1993 linked an issue Apr 5, 2024 that may be closed by this pull request
@zghp
Copy link
Contributor

zghp commented Apr 5, 2024

for Doxygen:

  • easy to set up and configure
  • automated code extraction and support for graphical diagrams (without the aid of external tools, unlike Sphynx)
  • useful if there are c/c++ components present within the project

for Sphynx:⁠

  • specifically designed for documenting Python projects
  • more freedom and flexibility while documenting
  • have the possibility to customise the theme to match the Sky branding (if relevant)
  • various extensions and plugins available

Look-wise, Doxygen would be good to use for a more familiar "vibe" but , personally, I would go with Sphynx since it has a modern look, it's made for Python and, since the project is intended to be used outside of Sky at some point, more attractive to new users.

@Ulrond Ulrond changed the base branch from master to develop April 9, 2024 09:09
@TB-1993 TB-1993 closed this Apr 9, 2024
@TB-1993 TB-1993 deleted the feature/gh4_select_documentation_tool branch April 9, 2024 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Select a documentation generation tool
3 participants