Bug 2879 – Wrong Description in functions (GetCwMax and GetCwMin) in ns3::DcfState Class

Bug 2879 - Wrong Description in functions (GetCwMax and GetCwMin) in ns3::DcfState Class


Summary:	Wrong Description in functions (GetCwMax and GetCwMin) in ns3::DcfState Class

Status:	RESOLVED FIXED

Product:	ns-3
Classification:	Unclassified
Component:	documentation
Version:	ns-3.27
Hardware:	All All

Importance:	P3 normal
Assigned To:	Tom Henderson

URL:
Keywords:

Depends on:
Blocks:
	Show dependency tree / graph

Reported:	2018-02-20 01:18 UTC by Muhammad Asif Khan
Modified:	2018-03-06 00:43 UTC (History)
CC List:	1 user (show)

See Also:

Attachments
Snapshot of ns3::DcfState Class documentation (68.43 KB, image/png) 2018-02-20 01:18 UTC, Muhammad Asif Khan	Details
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.

Description Muhammad Asif Khan 2018-02-20 01:18:42 UTC

Created attachment 3049 [details]
Snapshot of ns3::DcfState Class documentation

In the class ns3::DcfState Class, the two member functions given below:

----------------------------------------------------------------------
uint32_t 	GetCwMax (void) const
 	Return the maximum congestion window size. More...
 
uint32_t 	GetCwMin (void) const
 	Return the minimum congestion window size. More...
----------------------------------------------------------------------

(URL: https://www.nsnam.org/doxygen/classns3_1_1_dcf_state.html)

The word "congestion" should be replaced with "contention". Snapshot attached for reference.

PS. Sorry if I am wrong, however, in my understanding, it was supposed to be contention.

Regards,
_Asif

Comment 1 Tom Henderson 2018-02-22 15:47:27 UTC

I agree with the proposed change.

Comment 2 Tom Henderson 2018-03-06 00:43:05 UTC

fixed in changeset 13394:9793d33a2ca0