Re: [cdi-devel] [PATCH] pci.h: Improve documentation

[Max Reitz <max@xxxxxxxxxx>]

Kevil Wolf wrote:
> Add some comments for previously undocumented structures, convert German
> comment to UTF-8 and add English translations.
> 
> Signed-off-by: Kevin Wolf <kevin@xxxxxxxxxx>

Good, but I still found some Umlauts to be inserted (I like that word):

[…]
>  /**
> - * Reserviert die IO-Ports des PCI-Geraets fuer den Treiber
> + * \german
> + * Reserviert die IO-Ports des PCI-Geräts fuer den Treiber
für
> + * \endgerman
> + * \english
> + * Allocates the IO ports of the PCI device for the driver
> + * \endenglish
>   */
>  void cdi_pci_alloc_ioports(struct cdi_pci_device* device);
>  
>  /**
> + * \german
>   * Gibt die IO-Ports des PCI-Geraets frei
Gerät
> + * \endgerman
> + * \english
> + * Frees the IO ports of the PCI device
> + * \endenglish
>   */
>  void cdi_pci_free_ioports(struct cdi_pci_device* device);
>  
>  /**
> - * Reserviert den MMIO-Speicher des PCI-Geraets fuer den Treiber
> + * \german
> + * Mappt den MMIO-Speicher des PCI-Geraets
Geräts
> + * \endgerman
> + * \english
> + * Maps the MMIO memory of the PCI device
> + * \endenglish
>   */
>  void cdi_pci_alloc_memory(struct cdi_pci_device* device);
>  
>  /**
> + * \german
>   * Gibt den MMIO-Speicher des PCI-Geraets frei
Geräts
> + * \endgerman
> + * \english
> + * Frees the MMIO memory of the PCI device
> + * \endenglish
>   */
>  void cdi_pci_free_memory(struct cdi_pci_device* device);

All in all:

Acked-by: Max Reitz <max@xxxxxxxxxx>