Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Autocoders: finishPortH.tmpl, clerical error #875

Merged
merged 1 commit into from Jul 29, 2021
Merged

fix: Autocoders: finishPortH.tmpl, clerical error #875

merged 1 commit into from Jul 29, 2021

Conversation

ghost
Copy link

@ghost ghost commented Jul 29, 2021

Originating Project/Creator Autocoder
Affected Component xxPortAc.hpp
Affected Architectures(s) n
Related Issue(s) n
Has Unit Tests (y/n) n
Builds Without Errors (y/n) y
Unit Tests Pass (y/n) y
Documentation Included (y/n) n

Change Description

The template "finishPortH.tmpl" for creating the last part of "[xx]PortAc.hpp", has an obvious comment error. It is not a functional error, but better to be corrected as well.

as an example:

The CyclePortAc.hpp likes this:

/// Input Cycle port description
/// 

class OutputCyclePort : public Fw::OutputPortBase {
  public: 
    OutputCyclePort(void);

**After modification: ** (Comment has changed: /// Input --> /// Output)

/// Output Cycle port description
/// 

class OutputCyclePort : public Fw::OutputPortBase {
  public: 
    OutputCyclePort(void);

Rationale

A comment clerical error

Testing/Review Recommendations

Not related specific feature for this

Future Work

Review all templates in autocoder, check if there are other similar issues.

The template "finishPortH.tmpl" for creating the last part of "[xx]PortAc.hpp", has an obvious comment error. It is not a functional error, but better to be corrected as well.

as an example:

The CyclePortAc.hpp likes this:
```
    /// Input Cycle port description
    /// 
    
    class OutputCyclePort : public Fw::OutputPortBase {
      public: 
        OutputCyclePort(void);
```

--->

```
    /// Output Cycle port description
    /// 
    
    class OutputCyclePort : public Fw::OutputPortBase {
      public: 
        OutputCyclePort(void);
```
Copy link
Collaborator

@LeStarch LeStarch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Thanks!

@LeStarch
Copy link
Collaborator

CI passes. Merging.

@LeStarch LeStarch merged commit b47358f into nasa:devel Jul 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants