Bug 286

Summary: Bridge device type needs documentation
Product: ns-3 Reporter: Rajib Bhattacharjea <raj.b>
Component: documentationAssignee: Gustavo J. A. M. Carneiro <gjcarneiro>
Status: RESOLVED FIXED    
Severity: normal CC: gjcarneiro
Priority: P3    
Version: ns-3.1   
Hardware: All   
OS: All   
Attachments: docs patch
docs v2

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)