Bug 272 - InternetStackHelper::Install does not mention the fact that it aggregates PacketSocketFactory
InternetStackHelper::Install does not mention the fact that it aggregates Pac...
Status: RESOLVED FIXED
Product: ns-3
Classification: Unclassified
Component: helpers
pre-release
All All
: P3 normal
Assigned To: Tom Henderson
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2008-08-05 12:48 EDT by Mathieu Lacage
Modified: 2011-08-18 01:39 EDT (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Mathieu Lacage 2008-08-05 12:48:47 EDT
Generally, there is little mention in the tutorial or the API documentation that each helper is used to aggregate a small bit of functionality to a node/class. We should try to mention that somewhere to make the relationship between helper and low-level classes clearer.

This relates to bug 271
Comment 1 Craig Dowell 2008-08-05 13:05:51 EDT
The tutorial has become a kind of minimal introduction to scripts.  I ripped out a lot of stuff that seemed to distract from what we were trying to accomplish.  

It seems like we need some tutorial backing documentation that "drills down" one level deeper into the helper implementation and explains it thoroughly.  It would be nice to tie this (hyperlink) it into the tutorial.

Of course, we need huge piles of operational documentation and most of it is unwritten.


Comment 2 Tom Henderson 2008-08-26 00:33:45 EDT
(In reply to comment #1)
> The tutorial has become a kind of minimal introduction to scripts.  I ripped
> out a lot of stuff that seemed to distract from what we were trying to
> accomplish.  
> 
> It seems like we need some tutorial backing documentation that "drills down"
> one level deeper into the helper implementation and explains it thoroughly.  It
> would be nice to tie this (hyperlink) it into the tutorial.
> 
> Of course, we need huge piles of operational documentation and most of it is
> unwritten.
> 

the ns-3 manual is appropriate for a deeper treatment. 

IMO, if you can flag stuff that needs written, adding a chapter placeholder with a suggested initial outline and subsections that simply say "write me" will be a reminder, much like the tracker is for code.