[go: up one dir, main page]

Menu

#87 Hide internal headers

0.2.3
done
nobody
None
nobody
2018-08-22
2017-03-22
Ulf Lorenz
No

There are some header files and classes that are not for consumption by the user, but are exclusively meant for use inside the Wavepacket library. Examples are chebychev_internal.hpp, or the class FormattingScope.

These headers / classes should either not be accessible at all for the user or at least explicitly marked as internal to the library. Possible solutions would be to put the headers into the src/ directory, or extract the classes and put all headers into internal directories, or to add preprocessor macros that prohibit the inclusion of these headers unless specific macros are set.


Internal headers have been moved to the src/ directory. They are always used exclusively in one package, so referencing them by name only (instead of directory) was sufficient.

Discussion

  • Ulf Lorenz

    Ulf Lorenz - 2017-05-14
    • Description has changed:

    Diff:

    --- old
    +++ new
    @@ -1 +1 @@
    -Some classes have internal implementation details (e.g., the Checbychev propagator). These should be hidden from user view, not quite sure how. One option would be to put it in the src directory.
    +Some classes have internal implementation details (e.g., the Checbychev propagator) or are generally unsuited for direct user interfacing (e.g., FormattingScope). These should be hidden from user view, not quite sure how. One option would be to put it in the src directory.
    
     
  • Ulf Lorenz

    Ulf Lorenz - 2017-08-21
    • Description has changed:

    Diff:

    --- old
    +++ new
    @@ -1 +1,3 @@
    -Some classes have internal implementation details (e.g., the Checbychev propagator) or are generally unsuited for direct user interfacing (e.g., FormattingScope). These should be hidden from user view, not quite sure how. One option would be to put it in the src directory.
    +There are some header files and classes that are not for consumption by the user, but are exclusively meant for use inside the Wavepacket library. Examples are chebychev_internal.hpp, or the class FormattingScope.
    +
    +These headers / classes should either not be accessible at all for the user or at least explicitly marked as internal to the library. Possible solutions would be to put the headers into the src/ directory, or extract the classes and put all headers into internal directories, or to add preprocessor macros that prohibit the inclusion of these headers unless specific macros are set.
    
     
  • Ulf Lorenz

    Ulf Lorenz - 2017-11-11
    • Milestone: Backlog --> 0.3 goal
     
  • Ulf Lorenz

    Ulf Lorenz - 2018-08-18
    • Milestone: 0.3 goal --> 0.2.3
     
  • Ulf Lorenz

    Ulf Lorenz - 2018-08-18
    • status: open --> assigned
    • assigned_to: Ulf Lorenz
     
  • Ulf Lorenz

    Ulf Lorenz - 2018-08-22
    • Description has changed:

    Diff:

    --- old
    +++ new
    @@ -1,3 +1,7 @@
     There are some header files and classes that are not for consumption by the user, but are exclusively meant for use inside the Wavepacket library. Examples are chebychev_internal.hpp, or the class FormattingScope.
    
     These headers / classes should either not be accessible at all for the user or at least explicitly marked as internal to the library. Possible solutions would be to put the headers into the src/ directory, or extract the classes and put all headers into internal directories, or to add preprocessor macros that prohibit the inclusion of these headers unless specific macros are set.
    +
    +----
    +
    +Internal headers have been moved to the src/ directory. They are always used exclusively in one package, so referencing them by name only (instead of directory) was sufficient.
    
    • status: assigned --> done
    • assigned_to: Ulf Lorenz --> nobody
     

Log in to post a comment.