src/hwinfo/doc/libhd.doc

   1 /*! \mainpage libhd documentation
   2
   3 <h2>Introduction</h2>
   4
   5 libhd is a hardware detection lib.
   6
   7 <h2>Changes</h2>
   8
   9 \ref libhd_5_12
  10
  11 <h2>Examples</h2>
  12
  13 \ref example1
  14
  15 \ref example2
  16
  17 */
  18
  19
  20 /*! \page examples Examples
  21
  22 \ref example1
  23
  24 \ref example2
  25
  26 <hr>
  27
  28 \subsection example1 Get list of SCSI controllers
  29
  30 \include example1.c
  31
  32 <hr>
  33
  34 \subsection example2 Get primary display controller
  35
  36 \include example2.c
  37
  38 */
  39
  40 /*! \page changes Changes
  41
  42 \ref libhd_5_12
  43
  44 <hr>
  45
  46 \subsection libhd_5_12 libhd-5.12
  47
  48 <ul>
  49
  50   <li>changes in \ref hd_t
  51
  52     <ul>
  53
  54     <li>\ref hd_t::bus "bus" is now a struct, use \ref hd_t::bus "bus.id" instead.
  55
  56     <li>\ref hd_t::base_class "base_class" is now a struct, use \ref hd_t::base_class "base_class.id" instead.
  57
  58     <li>\ref hd_t::sub_class "sub_class" is now a struct, use \ref hd_t::sub_class "sub_class.id" instead.
  59
  60     <li>\ref hd_t::prog_if "prog_if" is now a struct, use \ref hd_t::prog_if "prog_if.id" instead.
  61
  62     <li>\ref hd_t::vendor "vendor" is a struct replacing vend and vend_name.
  63       Use \ref hd_t::vendor "vendor.id" and \ref hd_t::vendor "vendor.name" now.
  64
  65     <li>\ref hd_t::device "device" is a struct replacing dev and dev_name.
  66       Use \ref hd_t::device "device.id" and \ref hd_t::device "device.name" now.
  67
  68     <li>\ref hd_t::sub_vendor "sub_vendor" is a struct replacing sub_vend and sub_vend_name.
  69       Use \ref hd_t::sub_vendor "sub_vendor.id" and \ref hd_t::sub_vendor "sub_vendor.name" now.
  70
  71     <li>\ref hd_t::sub_device "sub_device" is a struct replacing sub_dev and sub_dev_name.
  72       Use \ref hd_t::sub_device "sub_device.id" and \ref hd_t::sub_device "sub_device.name" now.
  73
  74     <li>\ref hd_t::revision "revision" is a struct replacing rev and rev_name.
  75       Use \ref hd_t::revision "revision.id" and \ref hd_t::revision "revision.name" now.
  76
  77     <li>\ref hd_t::compat_vendor "compat_vendor" is a struct replacing compat_vend.
  78       Use \ref hd_t::compat_vendor "compat_vendor.id" now.
  79
  80     <li>\ref hd_t::compat_device "compat_device" is a struct replacing compat_dev.
  81       Use \ref hd_t::compat_device "compat_device.id" now.
  82
  83     </ul>
  84
  85   <li>interface functions removed
  86
  87     <ul>
  88
  89     <li>hd_bus_name is gone. Use \ref hd_t::bus "bus.name" instead.
  90
  91     <li>hd_class_name is gone. Use \ref hd_t::base_class "base_class.name",
  92       \ref hd_t::sub_class "sub_class.name" or \ref hd_t::prog_if "prog_if.name" instead.
  93
  94     <li>hd_vendor_name is gone. Use \ref hd_t::vendor "vendor.name" instead.
  95
  96     <li>hd_device_name is gone. Use \ref hd_t::device "device.name" instead.
  97
  98     <li>hd_sub_device_name is gone. Use \ref hd_t::sub_device "sub_device.name" instead.
  99
 100     <li>hd_find_device_by_name is gone.
 101
 102     </ul>
 103
 104 </ul>
 105
 106 <hr>
 107
 108 */
 109