Skip to content

Commit 4e542a3

Browse files
Fix documentation
1 parent 89ca519 commit 4e542a3

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

include/ReadoutCard/ChannelFactory.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ class ChannelFactory
4040

4141
/// Get an object to access a BAR with the given card ID and channel number.
4242
/// Passing 'DUMMY_SERIAL_NUMBER' as serial number returns a dummy implementation
43-
/// \param parameters Parameters for the channel
43+
/// \param cardId ID of the card
44+
/// \param channel Channel number to open
4445
BarSharedPtr getBar(const Parameters::CardIdType& cardId, const Parameters::ChannelNumberType& channel)
4546
{
4647
return getBar(Parameters::makeParameters(cardId, channel));

src/Register.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
/// \file REGISTER.h
2-
/// \brief Definition of the REGISTER struct.
1+
/// \file Register.h
2+
/// \brief Definition of the Register struct.
33
///
44
/// \author Pascal Boeschoten ([email protected])
55

@@ -38,7 +38,7 @@ struct IntervalRegister
3838
{
3939
}
4040

41-
/// \param Index of the register
41+
/// \param index of the register
4242
Register get(int index) const
4343
{
4444
return Register(base + interval * index);

0 commit comments

Comments
 (0)