diff options
| author | Josh Blum <josh@joshknows.com> | 2011-03-21 10:44:46 -0700 |
|---|---|---|
| committer | Josh Blum <josh@joshknows.com> | 2011-03-21 10:44:46 -0700 |
| commit | 2183c502ee556013e543fcb1f2cf66386b8d7288 (patch) | |
| tree | 6df7d42e868e8860140016c9e35bc96fba35d5f8 | |
| parent | fb2059949e0ad898e745aafbe958dfb2f326b077 (diff) | |
| download | uhd-2183c502ee556013e543fcb1f2cf66386b8d7288.tar.gz uhd-2183c502ee556013e543fcb1f2cf66386b8d7288.tar.bz2 uhd-2183c502ee556013e543fcb1f2cf66386b8d7288.zip | |
uhd: added comments/documentation to clock_config
| -rw-r--r-- | host/include/uhd/types/clock_config.hpp | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/host/include/uhd/types/clock_config.hpp b/host/include/uhd/types/clock_config.hpp index a72eb63de..7301d43a0 100644 --- a/host/include/uhd/types/clock_config.hpp +++ b/host/include/uhd/types/clock_config.hpp @@ -26,10 +26,17 @@ namespace uhd{ * Clock configuration settings: * The source for the 10MHz reference clock. * The source and polarity for the PPS clock. + * + * Use the convenience functions external() and internal(), + * unless you have a special purpose and cannot use them. */ struct UHD_API clock_config_t{ //------ simple usage --------// + + //! A convenience function to create an external clock configuration static clock_config_t external(void); + + //! A convenience function to create an internal clock configuration static clock_config_t internal(void); //------ advanced usage --------// |