Skip to content

Commit 5ca5983

Browse files
committed
updated docs (tcp flags enumeration)
1 parent 39b24b2 commit 5ca5983

File tree

2 files changed

+35
-4
lines changed

2 files changed

+35
-4
lines changed

docs/source/pcapkit/const/tcp.rst

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ enumerations include:
1313
* - :class:`TCP_Checksum <pcapkit.const.tcp.checksum.Checksum>`
1414
- TCP Checksum [*]_
1515
* - :class:`TCP_MPTCPOption <pcapkit.const.tcp.mp_tcp_option.MPTCPOption>`
16-
- Multipath TCP options [*]_
16+
- Multipath TCP options
1717
* - :class:`TCP_Option <pcapkit.const.tcp.option.Option>`
18-
- TCP Option Kind Numbers
18+
- TCP Option Kind Numbers [*]_
19+
* - :class:`TCP_Flags <pcapkit.const.tcp.flags.Flags>`
20+
- TCP Header Flags [*]_
1921

2022
TCP Checksum
2123
============
@@ -56,9 +58,23 @@ which is automatically generated from :class:`pcapkit.vendor.tcp.option.Option`.
5658
:undoc-members:
5759
:show-inheritance:
5860

61+
TCP Header Flags
62+
================
63+
64+
.. module:: pcapkit.const.tcp.flags
65+
66+
This module contains the constant enumeration for **TCP Header Flags**,
67+
which is automatically generated from :class:`pcapkit.vendor.tcp.flags.Flags`.
68+
69+
.. autoclass:: pcapkit.const.tcp.flags.Flags
70+
:members:
71+
:undoc-members:
72+
:show-inheritance:
73+
5974
.. raw:: html
6075

6176
<hr />
6277

6378
.. [*] https://www.iana.org/assignments/tcp-parameters/tcp-parameters.xhtml#tcp-parameters-2
6479
.. [*] https://www.iana.org/assignments/tcp-parameters/tcp-parameters.xhtml#tcp-parameters-1
80+
.. [*] https://www.iana.org/assignments/tcp-parameters/tcp-parameters.xhtml#tcp-header-flags

docs/source/pcapkit/vendor/tcp.rst

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ vendor crawlers include:
1313
* - :class:`TCP_Checksum <pcapkit.vendor.tcp.checksum.Checksum>`
1414
- TCP Checksum [*]_
1515
* - :class:`TCP_MPTCPOption <pcapkit.vendor.tcp.mp_tcp_option.MPTCPOption>`
16-
- Multipath TCP options [*]_
16+
- Multipath TCP options
1717
* - :class:`TCP_Option <pcapkit.vendor.tcp.option.Option>`
18-
- TCP Option Kind Numbers
18+
- TCP Option Kind Numbers [*]_
19+
* - :class:`TCP_Flags <pcapkit.vendor.tcp.flags.Flags>`
20+
- TCP Header Flags [*]_
1921

2022
TCP Checksum
2123
============
@@ -53,9 +55,22 @@ which is automatically generating :class:`pcapkit.const.tcp.option.Option`.
5355
:members: FLAG, LINK
5456
:show-inheritance:
5557

58+
TCP Header Flags
59+
================
60+
61+
.. module:: pcapkit.vendor.tcp.flags
62+
63+
This module contains the vendor crawler for **TCP Header Flags**,
64+
which is automatically generating :class:`pcapkit.const.tcp.flags.Flags`.
65+
66+
.. autoclass:: pcapkit.vendor.tcp.flags.Flags
67+
:members: FLAG, LINK
68+
:show-inheritance:
69+
5670
.. raw:: html
5771

5872
<hr />
5973

6074
.. [*] https://www.iana.org/assignments/tcp-parameters/tcp-parameters.xhtml#tcp-parameters-2
6175
.. [*] https://www.iana.org/assignments/tcp-parameters/tcp-parameters.xhtml#tcp-parameters-1
76+
.. [*] https://www.iana.org/assignments/tcp-parameters/tcp-parameters.xhtml#tcp-header-flags

0 commit comments

Comments
 (0)