Skip to content

Commit 33b283e

Browse files
committed
update moduledocs
1 parent d165ccb commit 33b283e

File tree

3 files changed

+45
-50
lines changed

3 files changed

+45
-50
lines changed

lib/ex_webrtc/rtp/h264/nal_formats/fu/header.ex

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
defmodule ExWebRTC.RTP.H264.FU.Header do
2-
@moduledoc """
3-
Defines a structure representing Fragmentation Unit (FU) header
4-
which is defined in [RFC6184](https://tools.ietf.org/html/rfc6184#page-31)
5-
6-
```
7-
+---------------+
8-
|0|1|2|3|4|5|6|7|
9-
+-+-+-+-+-+-+-+-+
10-
|S|E|R| Type |
11-
+---------------+
12-
```
13-
"""
2+
@moduledoc false
3+
# Defines a structure representing Fragmentation Unit (FU) header
4+
# which is defined in [RFC6184](https://tools.ietf.org/html/rfc6184#page-31)
5+
#
6+
#
7+
# +---------------+
8+
# |0|1|2|3|4|5|6|7|
9+
# +-+-+-+-+-+-+-+-+
10+
# |S|E|R| Type |
11+
# +---------------+
12+
#
1413

1514
alias ExWebRTC.RTP.H264.NAL
1615

lib/ex_webrtc/rtp/h264/nal_formats/stap_a.ex

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,26 @@
11
defmodule ExWebRTC.RTP.H264.StapA do
2-
@moduledoc """
3-
Module responsible for parsing Single Time Agregation Packets type A.
4-
5-
Documented in [RFC6184](https://tools.ietf.org/html/rfc6184#page-22)
6-
7-
```
8-
0 1 2 3
9-
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
10-
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
11-
| RTP Header |
12-
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
13-
|STAP-A NAL HDR | NALU 1 Size | NALU 1 HDR |
14-
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
15-
| NALU 1 Data |
16-
: :
17-
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
18-
| | NALU 2 Size | NALU 2 HDR |
19-
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
20-
| NALU 2 Data |
21-
: :
22-
| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
23-
| :...OPTIONAL RTP padding |
24-
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
25-
```
26-
"""
2+
@moduledoc false
3+
# Module responsible for parsing Single Time Agregation Packets type A.
4+
#
5+
# Documented in [RFC6184](https://tools.ietf.org/html/rfc6184#page-22)
6+
#
7+
# 0 1 2 3
8+
# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
9+
# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
10+
# | RTP Header |
11+
# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
12+
# |STAP-A NAL HDR | NALU 1 Size | NALU 1 HDR |
13+
# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
14+
# | NALU 1 Data |
15+
# : :
16+
# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
17+
# | | NALU 2 Size | NALU 2 HDR |
18+
# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
19+
# | NALU 2 Data |
20+
# : :
21+
# | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
22+
# | :...OPTIONAL RTP padding |
23+
# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2724

2825
@spec parse(binary()) :: {:ok, [binary()]} | {:error, :packet_malformed}
2926
def parse(data) do

lib/ex_webrtc/rtp/h264/nal_header.ex

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
defmodule ExWebRTC.RTP.H264.NAL.Header do
2-
@moduledoc """
3-
Defines a structure representing Network Abstraction Layer Unit Header
4-
5-
Defined in [RFC 6184](https://tools.ietf.org/html/rfc6184#section-5.3)
6-
7-
```
8-
+---------------+
9-
|0|1|2|3|4|5|6|7|
10-
+-+-+-+-+-+-+-+-+
11-
|F|NRI| Type |
12-
+---------------+
13-
```
14-
"""
2+
@moduledoc false
3+
# Defines a structure representing Network Abstraction Layer Unit Header
4+
#
5+
# Defined in [RFC 6184](https://tools.ietf.org/html/rfc6184#section-5.3)
6+
#
7+
#
8+
# +---------------+
9+
# |0|1|2|3|4|5|6|7|
10+
# +-+-+-+-+-+-+-+-+
11+
# |F|NRI| Type |
12+
# +---------------+
13+
#
1514

1615
@typedoc """
1716
NRI stands for nal_ref_idc. This value represents importance of

0 commit comments

Comments
 (0)