Bug 286 – Bridge device type needs documentation

Bug 286 - Bridge device type needs documentation


Summary:	Bridge device type needs documentation

Status:	RESOLVED FIXED

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

Importance:	P3 normal
Assigned To:	Gustavo J. A. M. Carneiro

URL:
Keywords:

Depends on:
Blocks:
	Show dependency tree / graph

Reported:	2008-08-13 10:44 UTC by Rajib Bhattacharjea
Modified:	2008-08-26 07:24 UTC (History)
CC List:	1 user (show)

See Also:

Attachments
docs patch (1.99 KB, patch) 2008-08-25 13:23 UTC, Gustavo J. A. M. Carneiro	Details \| Diff
docs v2 (2.14 KB, patch) 2008-08-25 16:49 UTC, Gustavo J. A. M. Carneiro	Details \| Diff
Show Obsolete (1) 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 Rajib Bhattacharjea 2008-08-13 10:44:04 UTC

There are only stub \brief lines in the source, and no explanation of
what is modeled by this device type, what it could be used for, etc.
Some prose explanation would be great.

Comment 1 Gustavo J. A. M. Carneiro 2008-08-25 13:23:00 UTC

Created attachment 232 [details]
docs patch

I propose something like this.

Comment 2 Rajib Bhattacharjea 2008-08-25 13:49:28 UTC

Looks good.

Comment 3 Gustavo J. A. M. Carneiro 2008-08-25 16:49:07 UTC

Created attachment 233 [details]
docs v2

This version adds a warning about the wifi netdevice having to be AP mode.

Comment 4 Tom Henderson 2008-08-26 01:05:08 UTC

(In reply to comment #3)
> Created an attachment (id=233) [details]
> docs v2
> 
> This version adds a warning about the wifi netdevice having to be AP mode.
> 

+1 but please add the following:
 * \ingroup devices
+ * \defgroup bridge Bridge

so that it ends up in the Modules tab in the appropriate place

Comment 5 Gustavo J. A. M. Carneiro 2008-08-26 07:24:29 UTC

changeset:   3547:6d041a5be1db
user:        Gustavo J. A. M. Carneiro  <gjc@inescporto.pt>
date:        Tue Aug 26 12:25:08 2008 +0100
summary:     Bridge documentation (#286)