github.com/wfjm.w11
1
0
Fork 0
mirror of https://github.com/wfjm/w11.git synced 2026-03-10 04:54:26 +00:00
Code Issues Releases Wiki Activity

fix wrong doxygen trailing comments (clang -Wdocumentation)

Browse Source
This commit is contained in:
wfjm
2018-10-05 19:10:52 +02:00
parent 15efcf961f
commit 37da9f19fa
16 changed files with 77 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/CHANGELOG.md
View File

@@ -47,13 +47,17 @@ The full set of tests is only run for tagged releases.
- add pdp11_dmpcnt: performance counters
### Changes
- use for C++ compiles also `-Wpedantic`
- sys_w11_n4: reduce cache from 64 to 32 kB to keep timing closure
- changes for DM_STAT_* signals (debug and monitoring)
- DM_STAT_SE: add cpbusy and idec
- RtclRw11Unit: fix for clang: M_virt() now public
- backend code review:
- use for C++ compiles also `-Wpedantic`
- fixes for uninitialized variables (coverity, all uncritical)
- now -Wunused-parameter clean (comment unused params)
- now -Wunused-variable clean (comment so far unused code)
- now -Wunused-parameter clean (comment out unused params)
- now -Wunused-variable clean (comment out so far unused code)
- some selected clang -Weverything aspects
- now -Wdocumentation clean (some wrong doxygen trailing comments)
### Bug Fixes
- RtclArgs.hpp: BUGFIX: get *_min limits correct (gcc -Wpedantic)

10
tools/src/librlink/RlinkPacketBufRcv.hpp
View File

@@ -1,4 +1,4 @@
// $Id: RlinkPacketBufRcv.hpp 983 2018-01-02 20:35:59Z mueller $
// $Id: RlinkPacketBufRcv.hpp 1052 2018-09-30 08:10:52Z mueller $
//
// Copyright 2014-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
//
@@ -47,10 +47,10 @@ namespace Retro {
void FlushRaw();
enum pkt_state {
kPktPend=0, //<! pending, still being filled
kPktResp, //<! response packet (SOP+EOP)
kPktAttn, //<! attn notify packet (ATTN+EOP)
kPktError //<! errorous packet
kPktPend=0, //!< pending, still being filled
kPktResp, //!< response packet (SOP+EOP)
kPktAttn, //!< attn notify packet (ATTN+EOP)
kPktError //!< errorous packet
};
pkt_state PacketState();

8
tools/src/librlink/RlinkPort.hpp
View File

@@ -1,4 +1,4 @@
// $Id: RlinkPort.hpp 983 2018-01-02 20:35:59Z mueller $
// $Id: RlinkPort.hpp 1052 2018-09-30 08:10:52Z mueller $
//
// Copyright 2011-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
//
@@ -85,9 +85,9 @@ namespace Retro {
int detail=0) const;
// some constants (also defined in cpp)
static const int kEof = 0; //<! return code: end-of-file
static const int kTout = -1; //<! return code: time out
static const int kErr = -2; //<! return code: IO error
static const int kEof = 0; //!< return code: end-of-file
static const int kTout = -1; //!< return code: time out
static const int kErr = -2; //!< return code: IO error
// statistics counter indices
enum stats {

16
tools/src/librlink/RlinkServer.hpp
View File

@@ -1,4 +1,4 @@
// $Id: RlinkServer.hpp 983 2018-01-02 20:35:59Z mueller $
// $Id: RlinkServer.hpp 1052 2018-09-30 08:10:52Z mueller $
//
// Copyright 2013-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
//
@@ -54,10 +54,10 @@ namespace Retro {
public:
struct AttnArgs {
uint16_t fAttnPatt; //<! in: current attention pattern
uint16_t fAttnMask; //<! in: handler attention mask
uint16_t fAttnHarvest; //<! out: harvested attentions
bool fHarvestDone; //<! out: set true when harvested
uint16_t fAttnPatt; //!< in: current attention pattern
uint16_t fAttnMask; //!< in: handler attention mask
uint16_t fAttnHarvest; //!< out: harvested attentions
bool fHarvestDone; //!< out: set true when harvested
AttnArgs();
AttnArgs(uint16_t apatt, uint16_t amask);
};
@@ -117,9 +117,9 @@ namespace Retro {
kStatNEloopPoll, //!< event loop turns (poll)
kStatNWakeupEvt, //!< Wakeup events
kStatNRlinkEvt, //!< Rlink data events
kStatNAttnHdl, //<! Attn handler calls
kStatNAttnNoti, //<! Attn notifies processed
kStatNAttnHarv, //<! Attn handler restarts
kStatNAttnHdl, //!< Attn handler calls
kStatNAttnNoti, //!< Attn notifies processed
kStatNAttnHarv, //!< Attn handler restarts
kStatNAttn00, //!< Attn bit 0 set
kStatNAttn01, //!< Attn bit 1 set
kStatNAttn02, //!< Attn bit 2 set

4
tools/src/librlinktpp/RtclRlinkServer.hpp
View File

@@ -1,4 +1,4 @@
// $Id: RtclRlinkServer.hpp 983 2018-01-02 20:35:59Z mueller $
// $Id: RtclRlinkServer.hpp 1052 2018-09-30 08:10:52Z mueller $
//
// Copyright 2013-2015 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
//
@@ -65,7 +65,7 @@ namespace Retro {
typedef alist_t::iterator alist_it_t;
boost::shared_ptr<RlinkConnect> fspConn;
alist_t fAttnHdl; //<! list of attn handlers
alist_t fAttnHdl; //!< list of attn handlers
RtclGetList fGets;
RtclSetList fSets;
};

6
tools/src/librtcltools/RtclClassBase.hpp
View File

@@ -1,4 +1,4 @@
// $Id: RtclClassBase.hpp 983 2018-01-02 20:35:59Z mueller $
// $Id: RtclClassBase.hpp 1052 2018-09-30 08:10:52Z mueller $
//
// Copyright 2011-2013 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
//
@@ -42,8 +42,8 @@ namespace Retro {
Tcl_Command Token() const;
// some constants (also defined in cpp)
static const int kOK = TCL_OK; //<!
static const int kERR = TCL_ERROR; //<!
static const int kOK = TCL_OK; //!<
static const int kERR = TCL_ERROR; //!<
protected:
void SetType(const std::string& type);

6
tools/src/librtcltools/RtclCmdBase.hpp
View File

@@ -1,4 +1,4 @@
// $Id: RtclCmdBase.hpp 983 2018-01-02 20:35:59Z mueller $
// $Id: RtclCmdBase.hpp 1052 2018-09-30 08:10:52Z mueller $
//
// Copyright 2013-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
//
@@ -58,8 +58,8 @@ namespace Retro {
bool TstMeth(const std::string& name);
// some constants (also defined in cpp)
static const int kOK = TCL_OK; //<!
static const int kERR = TCL_ERROR; //<!
static const int kOK = TCL_OK; //!<
static const int kERR = TCL_ERROR; //!<
protected:
bool GetArgsDump(RtclArgs& args, int& detail);

6
tools/src/librw11/Rw11CntlPC11.hpp
View File

@@ -1,4 +1,4 @@
// $Id: Rw11CntlPC11.hpp 983 2018-01-02 20:35:59Z mueller $
// $Id: Rw11CntlPC11.hpp 1052 2018-09-30 08:10:52Z mueller $
//
// Copyright 2013-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
//
@@ -59,8 +59,8 @@ namespace Retro {
static const uint16_t kPCSR = 004; //!< PCSR reg offset
static const uint16_t kPBUF = 006; //!< PBUF reg offset
static const uint16_t kUnit_PR = 0; //<! unit number of paper reader
static const uint16_t kUnit_PP = 1; //<! unit number of paper puncher
static const uint16_t kUnit_PR = 0; //!< unit number of paper reader
static const uint16_t kUnit_PP = 1; //!< unit number of paper puncher
static const uint16_t kProbeOff = kRCSR; //!< probe address offset (rcsr)
static const bool kProbeInt = true; //!< probe int active

4
tools/src/librw11/Rw11UnitTape.hpp
View File

@@ -1,4 +1,4 @@
// $Id: Rw11UnitTape.hpp 983 2018-01-02 20:35:59Z mueller $
// $Id: Rw11UnitTape.hpp 1052 2018-09-30 08:10:52Z mueller $
//
// Copyright 2015-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
//
@@ -76,7 +76,7 @@ namespace Retro {
std::string fType; //!< drive type
bool fEnabled; //!< unit enabled
bool fWProt; //!< unit write protected
size_t fCapacity; //<! capacity in byte (0=unlimited)
size_t fCapacity; //!< capacity in byte (0=unlimited)
};
} // end namespace Retro

20
tools/src/librw11/Rw11UnitTerm.hpp
View File

@@ -1,4 +1,4 @@
// $Id: Rw11UnitTerm.hpp 983 2018-01-02 20:35:59Z mueller $
// $Id: Rw11UnitTerm.hpp 1052 2018-09-30 08:10:52Z mueller $
//
// Copyright 2013-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
//
@@ -80,15 +80,15 @@ namespace Retro {
virtual void AttachDone();
protected:
bool fTo7bit; //<! discard parity bit on output
bool fToEnpc; //<! escape non-printables on output
bool fTi7bit; //<! discard parity bit on input
std::deque<uint8_t> fRcvQueue; //<! input queue
std::string fLogFname; //<! log file name
std::ofstream fLogStream; //<! log file stream
bool fLogOptCrlf; //<! log file: crlf option given
bool fLogCrPend; //<! log file: cr pending
bool fLogLfLast; //<! log file: lf was last char
bool fTo7bit; //!< discard parity bit on output
bool fToEnpc; //!< escape non-printables on output
bool fTi7bit; //!< discard parity bit on input
std::deque<uint8_t> fRcvQueue; //!< input queue
std::string fLogFname; //!< log file name
std::ofstream fLogStream; //!< log file stream
bool fLogOptCrlf; //!< log file: crlf option given
bool fLogCrPend; //!< log file: cr pending
bool fLogLfLast; //!< log file: lf was last char
};
} // end namespace Retro

8
tools/src/librw11/Rw11Virt.hpp
View File

@@ -1,4 +1,4 @@
// $Id: Rw11Virt.hpp 983 2018-01-02 20:35:59Z mueller $
// $Id: Rw11Virt.hpp 1052 2018-09-30 08:10:52Z mueller $
//
// Copyright 2013-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
//
@@ -69,10 +69,10 @@ namespace Retro {
};
protected:
Rw11Unit* fpUnit; //<! back ref to unit
Rw11Unit* fpUnit; //!< back ref to unit
RparseUrl fUrl;
bool fWProt; //<! write protected
Rstats fStats; //<! statistics
bool fWProt; //!< write protected
Rstats fStats; //!< statistics
};
} // end namespace Retro

8
tools/src/librw11/Rw11VirtDisk.hpp
View File

@@ -1,4 +1,4 @@
// $Id: Rw11VirtDisk.hpp 983 2018-01-02 20:35:59Z mueller $
// $Id: Rw11VirtDisk.hpp 1052 2018-09-30 08:10:52Z mueller $
//
// Copyright 2013-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
//
@@ -67,11 +67,11 @@ namespace Retro {
};
protected:
size_t fBlkSize; //<! block size in byte
size_t fNBlock; //<! disk size in blocks
size_t fBlkSize; //!< block size in byte
size_t fNBlock; //!< disk size in blocks
protected:
static std::string sDefaultScheme; //<! default scheme
static std::string sDefaultScheme; //!< default scheme
};
} // end namespace Retro

4
tools/src/librw11/Rw11VirtEthTap.hpp
View File

@@ -1,4 +1,4 @@
// $Id: Rw11VirtEthTap.hpp 983 2018-01-02 20:35:59Z mueller $
// $Id: Rw11VirtEthTap.hpp 1052 2018-09-30 08:10:52Z mueller $
//
// Copyright 2014-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
//
@@ -49,7 +49,7 @@ namespace Retro {
int RcvPollHandler(const pollfd& pfd);
protected:
int fFd; //<! fd for pty master side
int fFd; //!< fd for pty master side
};
} // end namespace Retro

8
tools/src/librw11/Rw11VirtStream.hpp
View File

@@ -1,4 +1,4 @@
// $Id: Rw11VirtStream.hpp 983 2018-01-02 20:35:59Z mueller $
// $Id: Rw11VirtStream.hpp 1052 2018-09-30 08:10:52Z mueller $
//
// Copyright 2013-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
//
@@ -64,9 +64,9 @@ namespace Retro {
};
protected:
bool fIStream; //<! is input (read only) stream
bool fOStream; //<! is output (write only) stream
FILE* fFile; //<! file ptr
bool fIStream; //!< is input (read only) stream
bool fOStream; //!< is output (write only) stream
FILE* fFile; //!< file ptr
};
} // end namespace Retro

28
tools/src/librw11/Rw11VirtTape.hpp
View File

@@ -1,4 +1,4 @@
// $Id: Rw11VirtTape.hpp 983 2018-01-02 20:35:59Z mueller $
// $Id: Rw11VirtTape.hpp 1052 2018-09-30 08:10:52Z mueller $
//
// Copyright 2015-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
//
@@ -86,22 +86,22 @@ namespace Retro {
// operation code
enum OpCode {
kOpCodeOK = 0, //<! operation OK
kOpCodeBot, //<! ended at BOT
kOpCodeEof, //<! ended at EOF
kOpCodeEom, //<! ended at EOM
kOpCodeRecLenErr, //<! record length error
kOpCodeBadParity, //<! record with parity error
kOpCodeBadFormat //<! file format error
kOpCodeOK = 0, //!< operation OK
kOpCodeBot, //!< ended at BOT
kOpCodeEof, //!< ended at EOF
kOpCodeEom, //!< ended at EOM
kOpCodeRecLenErr, //!< record length error
kOpCodeBadParity, //!< record with parity error
kOpCodeBadFormat //!< file format error
};
protected:
size_t fCapacity; //<! capacity in byte (0=unlimited)
bool fBot; //<! tape at bot
bool fEot; //<! tape beyond eot
bool fEom; //<! tape beyond medium
int fPosFile; //<! tape pos: #files (-1=unknown)
int fPosRecord; //<! tape pos: #record (-1=unknown)
size_t fCapacity; //!< capacity in byte (0=unlimited)
bool fBot; //!< tape at bot
bool fEot; //!< tape beyond eot
bool fEom; //!< tape beyond medium
int fPosFile; //!< tape pos: #files (-1=unknown)
int fPosRecord; //!< tape pos: #record (-1=unknown)
};
} // end namespace Retro

4
tools/src/librw11/Rw11VirtTermPty.hpp
View File

@@ -1,4 +1,4 @@
// $Id: Rw11VirtTermPty.hpp 983 2018-01-02 20:35:59Z mueller $
// $Id: Rw11VirtTermPty.hpp 1052 2018-09-30 08:10:52Z mueller $
//
// Copyright 2013-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
//
@@ -50,7 +50,7 @@ namespace Retro {
int RcvPollHandler(const pollfd& pfd);
protected:
int fFd; //<! fd for pty master side
int fFd; //!< fd for pty master side
};
} // end namespace Retro