[CONTROLLER-330] Enhance inline comments and documentation for the MD-SAL toaster example Created: 16/Apr/14 Updated: 20/May/14 Resolved: 20/May/14 |
|
| Status: | Resolved |
| Project: | controller |
| Component/s: | mdsal |
| Affects Version/s: | Helium |
| Fix Version/s: | None |
| Type: | Bug | ||
| Reporter: | Devin Avery | Assignee: | Devin Avery |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Environment: |
Operating System: Mac OS |
||
| External issue ID: | 761 |
| Description |
|
The "toaster" example in the MD-SAL structure could be improved with inline comments in both the .yang files AND the .java files to help tie the .yang files to the .java files as well as explain WHY each file is needed and WHAT each file is trying to do. |
| Comments |
| Comment by Devin Avery [ 16/Apr/14 ] |
|
Working on compiling initial notes on the toaster topic. |
| Comment by Devin Avery [ 16/Apr/14 ] |
| Comment by Devin Avery [ 20/May/14 ] |
|
Resolved with https://git.opendaylight.org/gerrit/#/c/6379/. Also documented on https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:Toaster_Tutorial#Toaster_Step-By-Step |