• D
    Fix API doc extractor to stop munging comment formatting · 5486abfe
    Daniel P. Berrange 提交于
    The python method help docs are copied across from the C
    funtion comments, but in the process all line breaks and
    indentation was being lost. This made the resulting text
    and code examples completely unreadable. Both the API
    doc extractor and the python generator were destroying
    whitespace & this fixes them to preserve it exactly.
    
    * docs/apibuild.py: Preserve all whitespace when extracting
      function comments. Print function comment inside a <![CDATA[
      section to fully preserve all whitespace. Look for the
      word 'returns' to describe return values, instead of 'return'
      to avoid getting confused with code examples including the
      C 'return' statement.
    * python/generator.py: Preserve all whitespace when printing
      function help docs
    * src/libvirt.c: Change any return parameter indicated by
      'return' to be 'returns', to avoid confusing the API extractor
    * docs/libvirt-api.xml: Re-build for fixed descriptions
    5486abfe
libvirt.c 250.0 KB