• Main Page
  • Related Pages
  • Modules
  • Classes
  • Files

usage_notes

Go to the documentation of this file.
00001 /*! \page page1 Usage Notes
00002 \section interfaces Interface Classes
00003 \par
00004 In general an interface class name is prefixed by a capital I and does not end with 'Imp'. Those classes whose names are prefixed with a capital I and end with 'Imp' inherit from the interface class with the related name. For example, OSGeo::FDO::Commands::Locking::IAcquireLock is the name of an interface class, and OSGeo::FDO::Commands::Locking::IAcquireLockImp is the name of an implementation class which inherits from IAcquireLock.
00005 \par
00006 In the table of contents click Modules, click Interfaces and then click Classes to see the list of all of the interface classes.
00007 \par
00008 In the table of contents click Modules, click a namespace node and then click Interfaces to see the list of interfaces belonging to that namespace.
00009 \note
00010 To see the description of the interface class methods click on the inherited by link and on the page describing the implementation class scroll to the bottom.
00011 \section impclasses Implementation Classes
00012 \par
00013 Click on 'Class List' to see the list of implementation classes.
00014 \note
00015 You will also see the interface classes there as well.
00016 \section enums Enumerations
00017 \par
00018 In the table of contents click Modules, click Enums and click Enumerations to see the list of all of the enumerations.
00019 \par
00020 In the table of contents click Modules, click a namespace node and then click Enumerations to see the list of enumerations belonging to that namespace.
00021 \section namespaces Namespaces
00022 \par
00023 Click 'Namespace List' to see the list of namespaces and then click a namespace name to see a list of classes and interfaces contained in that namespace.
00024 */
Please send us your comment about this page